Doxygen: differenze tra le versioni
Contenuto cancellato Contenuto aggiunto
m WPCleaner v1.30 - Disambigua corretto un collegamento - Applicazione |
Funzionalità collegamenti suggeriti: 2 collegamenti inseriti. Etichette: Modifica visuale Modifica da mobile Modifica da web per mobile Modifica da mobile avanzata Attività per i nuovi utenti Suggerito: aggiungi collegamenti |
||
| (16 versioni intermedie di 16 utenti non mostrate) | |||
Riga 1:
{{Software
|Nome = Doxygen
|Logo =
|Sviluppatore = Dimitri van Heesch
|UltimaVersione =
|DataUltimaVersione =
|UltimaVersioneBeta =
|DataUltimaVersioneBeta =
Line 12 ⟶ 10:
|Linguaggio =
|Genere = Sistema di documentazione
|SoftwareLibero = sì
|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]]
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 31 ⟶ 27:
Il risultato finale è disponibile sotto forma di pagine [[HTML]] oppure nei formati [[Microsoft Compressed HTML Help|CHM]], [[Rich text format|RTF]], [[PDF]], [[LaTeX]], [[PostScript]] o [[man (Unix)|man pages]] di [[Unix]].
Il formato HTML prodotto si giova di un sistema di [[collegamento ipertestuale|hyperlink]] molto curato che permette al lettore
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 [[Graphviz]], è 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 42 ⟶ 38:
Riportiamo di seguito un esempio.
<
/**
* The time class represents a moment of time.
Line 66 ⟶ 62:
}
};
</syntaxhighlight>
==Il
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 77 ⟶ 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:
<
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project.
Line 88 ⟶ 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 139 ⟶ 135:
LATEX_OUTPUT = latex
</syntaxhighlight>
Come si vede, attraverso il file di configurazione, l'utente stabilisce:
* Il nome del progetto
Line 170 ⟶ 166:
== Altri progetti ==
{{Interprogetto}}
== Collegamenti esterni ==
* {{Collegamenti esterni}}
* {{
{{Portale|software libero}}
| |||