Come ottenere il grafico di chiamata completo per scopi di documentazione?
-
16-09-2020 - |
Domanda
Il nostro team è necessario per documentare ogni metodo nel nostro codice e descrivere ciò che è passato e fuori e tali.È possibile generare automaticamente un documento contenente un albero gerarchico completo che inizia a una funzione e scendere a tutte le possibili espansioni di chiamata?Come?Usando Eclipse, Primavera, Ibernazione.Inoltre abbiamo accesso a Netbeans e qualsiasi altra cosa che aiuterebbe.
So che è completamente inutile, ma a volte ci troviamo in queste situazioni e non possiamo farlo molto: -).
Fondamentalmente ho bisogno di un generatore di grafico a chiamata Java, penso che la ragione per cui non riesco a trovarne uno perché le funzioni virtuali impediscono l'analisi statica?
Soluzione
Consiglio vivamente doxygen .
Anche con codice "non trattato", genererà chiamate alberi, diagrammi di ereditarietà di classe e altro come HTML.Se si aggiungono alcuni commenti appositamente formattati (uno per classe, funzione, struttura dati rilevabile) è possibile ottenere molto più fuori di esso.
Dai un'occhiata a Esempi e l'enorme Elenco dei progetti che utilizzano DOXYGEN .
I personalmente non userei nient'altro e insisterò che tutti i codici scritti nella mia azienda usano Doxygen.
Modifica: P.S Doxygenis così utile, anche sul codice non commentato che è il primo strumento che cerco quando eredita il codice legacy di qualcun altro.Nient'altro mi dà una buona panoramica così velocemente.
Altri suggerimenti
Non è una soluzione esatta al tuo problema, acquista che puoi usare l'API DOCLET e scrivere il tuo doclet.È possibile accedere ai metodi con i loro argomenti e i loro tipi di ritorno e molto altro.Quando vai in questo modo puoi anche afferrare i commenti del metodo per scopi di documentazione.