Doxygen: differenze tra le versioni

Versione delle 20:51, 25 ott 2008

Versione attuale delle 06:41, 28 giu 2024

(48 versioni intermedie di 36 utenti non mostrate)

Riga 1:

{{Infobox Software

|nomeNome = Doxygen

|Logo =

|logo = [[Immagine:Doxygen.png]]

|sviluppatoreSviluppatore = Dimitri van Heesch

|screenshot =

|didascaliaUltimaVersione =

|DataUltimaVersione =

|sviluppatore = Dimitri van Heesch

|UltimaVersioneBeta =

|versione_ultimo_rilascio = 1.5.7.1

|DataUltimaVersioneBeta =

|data_ultimo_rilascio = [[5 ottobre]] [[2007]]

|SistemaOperativo = multipiattaforma

|sistema_operativo = [[Multipiattaforma]]

|Linguaggio =

|genereGenere = sistemaSistema di documentazione

|licenza = [[licenza GPL]]

|SoftwareLibero = sì

|sito_web = http://www.doxygen.org

|Lingua =

}}

'''Doxygen''' è una [[applicazione (informatica)|applicazione]] per la generazione automatica della [[documentazione (ambito tecnico) |documentazione]] a partire dal [[codice sorgente]] di un generico [[software]]. È un progetto [[open source]] rilasciatodisponibile sotto [[licenza GPL]], scritto per la maggior parte da '''Dimitri van Heesch''' a partire dal [[1997]].

Doxygen è un sistema [[multipiattaforma]] ([[Windows]], [[Mac OS]], [[Linux]], ecc.) ed opera con i [[linguaggio di programmazione|linguaggi]] [[C++]], [[C (linguaggio)|C]], [[Java (linguaggio di programmazione)|Java]], [[Objective C]], [[Python]], [[Interface Description Language|IDL]] (versioni [[CORBA]] e [[Microsoft]]), [[Fortran]], [[PHP]], [[C sharp|C#]], e [[D (linguaggio di programmazione)|D]]. Nell'ambito del C++, è compatibile con le estensioni [[Qt (toolkit)|Qt]].

È il sistema di documentazione di gran lunga più utilizzato nei grandi progetti open source in C++. Due esempi per tutti, sono l'adozione di doxygen da parte di [[Adaptive Communication Environment|ACE]] e [[KDE]].

In Java invece, la posizione leader viene meno, in virtù della presenza del concorrente [[Javadoc]].

Il sistema estrae la documentazione dai [[commento (informatica)|commenti]] inseriti nel codice sorgente e dalla dichiarazione delle [[struttura dati|strutture dati]].

__TOC__

Line 25 ⟶ 26:

==La documentazione prodotta==

Il risultato finale è disponibile sotto forma di pagine [[htmlHTML]] oppure nei formati [[Microsoft Compressed HTML Help|CHM]], [[Rich text format|RTF]], [[PDF]], [[LaTeX]], [[PostScript]] o [[man (Unix)|man pages]] di [[Unix]].

Il formato htmlHTML prodotto si giova di un sistema di [[collegamento ipertestuale|hyperlink]] molto curato che permette al lettore una un'agevole navigazione della struttura dei [[File sorgente|file sorgenti]].

La documentazione prodotta riporta anche il [[diagramma delle classi]], nei casi in cui sono presenti relazioni di [[ereditarietà (informatica)|ereditarietà]] tra strutture dati. Grazie all'impiego sinergico di Doxygen con [[GraphVizGraphviz]], è possibile includere nella documentazione diagrammi delle classi per tutti gli altri tipi di relazioni tra strutture dati.

I documenti possono essere generati in diverse lingue, tra cui è compreso l'italiano.

Line 37 ⟶ 38:

Riportiamo di seguito un esempio.

<sourcesyntaxhighlight lang="Cppcpp">

/**

* The time class represents a moment of time.

Line 47 ⟶ 48:

/**

* Constructor that sets the time to a given value.

* \param timemillis is a numberNumber of milliseconds passed since Jan 1. 1970

*/

Time(int timemillis) {

Line 61 ⟶ 62:

}

};

</syntaxhighlight>

</source>

==Il [[file]] di configurazione==

Doxygen associa ad ogni progetto da documentare un [[file di configurazione]] che contiene le impostazioni da utilizzare per la generazione.

Questo file è un elenco di assegnazioni di opportuni valori a determinati parametri ('''TAG'''). Ogni tag è formato dalla coppia di informazioni

Line 72 ⟶ 73:

analogamente a quanto avviene nei file di configurazione di numerosi altri prodotti open source.

Un frammento di un esempio del file di configurazione è il seguente:

<sourcesyntaxhighlight lang="bash">

# The PROJECT_NAME tag is a single word (or a sequence of words surrounded

# by quotes) that should identify the project.

Line 83 ⟶ 84:

# where doxygen was started. If left blank the current directory will be used.

OUTPUT_DIRECTORY =

# The OUTPUT_LANGUAGE tag is used to specify the language in which all

Line 134 ⟶ 135:

LATEX_OUTPUT = latex

</syntaxhighlight>

</source>

Come si vede, attraverso il file di configurazione, l'utente stabilisce:

* Il nome del progetto

Line 164 ⟶ 165:

al termine della elaborazione, il materiale prodotto sarà disponibile nella directory di destinazione indicata nel file di configurazione.

==Voci correlateAltri progetti ==

{{Interprogetto}}

[[:en:Comparison of documentation generators]]

== Collegamenti esterni ==

* {{Collegamenti esterni}}

* {{en}}cita [web|http://www.codeproject.com/tipsArticles/doxysetup.asp 3528/10-Minutes-to-document-your-code|10 Minuti per documentare il codice]|lingua=en}}

{{Portale|Softwaresoftware libero}}

*{{en}} [http://www.stack.nl/~dimitri/doxygen/index.html Sito ufficiale del progetto]

*{{en}} [http://www.codeproject.com/tips/doxysetup.asp 10 Minuti per documentare il codice]

{{Portale|Software libero}}

[[Categoria:Software applicativo individuale - libero]]

[[cs:Doxygen]]

[[de:Doxygen]]

[[en:Doxygen]]

[[es:Doxygen]]

[[fr:Doxygen]]

[[id:Doxygen]]

[[ja:Doxygen]]

[[nl:Doxygen]]

[[pl:Doxygen]]

[[ru:Doxygen]]

[[sr:Доксиџен]]