Visualizzazione dei risultati da 1 a 2 su 2
  1. #1

    [Pillola]Doxygen

    Doxygen Tutorial
    Doxygen è un software open source utilissimo(1) che permette di documentare un software scritto in Java/C/C++.
    Si compone di 2 files doxygen.exe e doxytag.exe che possono essere messi ove si vuole ma per chiamarli
    senza dover inserire sempre il percorso bisogna inserirli nel PATH.
    Per spiegare il funzionamento di questo tool prendiamo un codice di esempio:

    codice:
    #include <iostream>
    
    /// il namespace std
    using namespace std;
    
    /// Classe Generica
    class Prova
    {
    	public:
    		///Costruttore
    		Prova(){ };
    		///Distruttore
    		~Prova(){ };
    		/// Funz che saluta
    		inline char * saluta(char * nm){ return nm; };
    	private:
    };
    
    int main()
    {
    	return 0;
    }
    Doxygen accetta come parametro(obligatorio) il file di configurazione, che può essere chiamato a proprio
    piacimento.
    doxygen <config-file>
    Noi per comodità lo chiameremo doxy.conf.
    Il files sarà cosi composto:

    ; Il nome del progetto
    PROJECT_NAME = "Prova"
    ;La lingua
    OUTPUT_LANGUAGE = "Italian"
    ; La directory ove porre la documentazione
    OUTPUT_DIRECTORY = "doc"
    ; # I Seguenti valori accettano YES o NO #
    ; Genera la documentazione HTML
    GENERATE_HTML = YES
    ; Permette la navigazione tra i files
    SOURCE_BROWSER = YES
    ; Disabilità la creazione della documentazione in formato LATEX
    GENERATE_LATEX = NO
    ; Legge le sotto-directory ricorsivamente
    RECURSIVE = YES
    ; Permette l' espansione delle macro
    MACRO_EXPANSION = YES
    Salviamo il files di configurazione nella directory principale del programma
    Il risultato dell' operazione e visibile nel mio sito(2).
    Dopo questa introduzione possiamo passare ad opzioni più avanzate.
    Aggiungeremo ora al nostro doxy.conf le seguenti opzioni e proveremo a vedere il risultato:

    ; # I Seguenti valori accettano YES o NO #
    ; Opzione disponibile per soli programmi in C
    OPTIMIZE_OUTPUT_FOR_C = NO
    ; Opzione disponibile per soli programmi in Java
    OPTIMIZE_OUTPUT_JAVA = NO
    ; Mostra il tag [inline] difianco ai membri di classe che lo sono
    INLINE_INFO = YES
    ; Valuta le espressioni macro presenti nel progetto
    ENABLE_PREPROCESSING = YES
    ; Se attivo Doxygen mostra le relazioni tra i template e le sue istanze
    TEMPLATE_RELATIONS = YES
    ; Permette la ricerca ma sul server deve essere presente PHP versione 4.1.0 o successive
    SEARCHENGINE = NO
    Detto questo ora possiamo dire che d'ora in poi i nostri programmi e librerie potranno essere
    documentati senza problemi



    Luc@s

    (1) http://www.stack.nl/~dimitri/doxygen...html#latestsrc
    (2) allegato
    La stupidità umana e l'universo sono infinite.
    Della seconda non sono certo(Einstein)

    Gnu/Linux User

  2. #2
    Moderatore di Programmazione L'avatar di alka
    Registrato dal
    Oct 2001
    residenza
    Reggio Emilia
    Messaggi
    23,904
    "BUMP!"

Permessi di invio

  • Non puoi inserire discussioni
  • Non puoi inserire repliche
  • Non puoi inserire allegati
  • Non puoi modificare i tuoi messaggi
  •  
Powered by vBulletin® Version 4.2.1
Copyright © 2020 vBulletin Solutions, Inc. All rights reserved.