codice sorgente di documentazione

[marcioandreyoliveira]

Salve.

Io uso Doxygen per generare la documentazione quando ho sviluppare un C / C o di un progetto Java.Purtroppo, Doxygen non genera documenti per il codice sorgente Assembly.

So che c'è uno script Perl chiamato asm4doxy.pl che generano una fonte falso c per consentire Doxygen generare la documentazione, ma non funziona molto bene.

Lo stesso autore da asm4doxy.pl ha un altro script chiamato asmdoc.pl.Non è così buono sia.

Sto provando NaturalDocs e RoboDocs ma non sono buone come Doxygen.

Qualcuno sa un altro software, come Doxygen che potrei usare per documentare i miei progetti in assemblea?

Grazie.

 

[rajeshkumar123]

salve,

Ho problemi nell'uso di doxygen di livello molto basilare.Can u help me con qualche codice sorgente di esempio che ho in grado di generare un documento in mio fine?

dovrei installare qualsiasi altro software diverso da doxygen?Grazie in anticipo !!!!!!!!!!!

 

[marcioandreyoliveira]

Salve.

Sarebbe bene (ma non necessario) se si ha installato graphviz.Essa permetterà Doxygen generare alcuni grafici che assomiglia a UML.È possibile ottenere qui: http://www.graphviz.org/Download_windows.php.

Per utilizzare Doxygen è necessario disporre di un file di configurazione.Questo file dovrebbe essere adattata ad ogni progetto (È necessario modificare gli stessi parametri. Per esempio, il nome del progetto e del tipo di codice sorgente: C, C o Java).

Io uso una configurazione denominata Doxyfile (potete chiamatelo come volete).Questo file è nella radice della directory del progetto.

Io uso questa topologia:
Codiceroject_dir /

|

-src /

| - Source1.java

| - Source2.java

| - ....

|

| - SourceN.java

|

-Doxyfile

 

[rajeshkumar123]

salve,

Penso che abbiano dato un programma di utilità per la generazione di file di configurazione.Che è giusto per generare file di configurazione o l'utilità modo ur?Grazie !!!!!

 

[marcioandreyoliveira]

Stai parlando doxywizard.

Ha tre modalità: procedura guidata, di esperti e di carico.

Modalità di procedura guidata genera quasi tutto con i valori di default.E 'un buon inizio se non sei abituato a Doxygen.

Expert mode ti permette di controllare molto di più perché è possibile specificare un sacco di animali diversi.

Pulsante Load si caricare un file di configurazione esistenti e consentono di modificare alcuni parametri.Così è un po 'più facile che aprirlo in un editor di testo.

Sì, è uno strumento molto bello.Si può scegliere tra adattare il mio Doxyfile o generare uno voi stessi.In entrambe le direzioni dovrebbe funzionare.

Ti suggerisco di generare il file di configurazione proprio.E 'facile e molto istruttivo.

Con i migliori saluti.

 

[rajeshkumar123]

salve,

Grazie alla fine il suo lavoro per me.

Grazie !!!!!!!!!!!!!!!!!!!! molto

 

[EDACoA]

Tank you