Doxygen

Doxygen è di fatto lo strumento standard per generare documentazione da fonti C ++ annotate, ma supporta anche altri linguaggi di programmazione popolari come C, Objective-C, C #, PHP, Java, Python, IDL (Corba, Microsoft e UNO / OpenOffice ), Fortran, VHDL, Tcl e in una certa misura D.

Doxygen può aiutarti in tre modi:

  1. Può generare un browser di documentazione online (in HTML) e/o un manuale di riferimento offline (in $ \ Mbox {\ LaTeX} $ ) da un set di file di origine documentati. C'è anche il supporto per generare output in RTF (MS-Word), PostScript, PDF hyperlinked, HTML compresso e pagine man Unix. La documentazione viene estratta direttamente dalle fonti, il che rende molto più semplice mantenere la documentazione coerente con il codice sorgente.
  2. È possibile configurare doxygen per estrarre la struttura del codice da file sorgente non documentati. Questo è molto utile per trovare rapidamente la strada nelle grandi distribuzioni di origine. Doxygen può anche visualizzare le relazioni tra i vari elementi mediante grafici di dipendenza, diagrammi di ereditarietà e diagrammi di collaborazione, tutti generati automaticamente.
  3. Puoi anche usare doxygen per creare la normale documentazione (come fatto per il manuale utente doxygen e il sito web).

Doxygen è sviluppato su Mac OS X e Linux, ma è configurato per essere altamente portatile. Di conseguenza, funziona anche con la maggior parte degli altri derivati Unix. Inoltre, sono disponibili eseguibili per Windows.

Argomenti

Etichette