|
|
|
|
Strumenti |
24-12-2003, 10:10 | #1 | |||
Senior Member
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
|
[Tutorial] 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; } piacimento. Quote:
Il files sarà cosi composto: Quote:
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: Quote:
documentati senza problemi Luc@s (1) http://www.stack.nl/~dimitri/doxygen...html#latestsrc (2) allegato
__________________
Gnu/Linux User |
|||
27-12-2003, 09:08 | #2 |
Senior Member
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
|
Piccolo consiglio, lasciate la lingua di default perche la traduzione di ora nn mi sembra il maximo.
Ciao e aspetto feedback
__________________
Gnu/Linux User |
27-12-2003, 10:29 | #3 |
Senior Member
Iscritto dal: Oct 2001
Messaggi: 11471
|
Non ho esperienza con doxy ma con javadoc ogni tanto ci lavoravo. Mi chiedevo se anche in doxy fosse possibile usare qui tag come @autor, @version, @param, @return...
tutti i commenti /// vengono messi nel file HTML vero ? perchè nel tutorial non se ne parla. ciao |
27-12-2003, 10:32 | #4 | |
Senior Member
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
|
Quote:
Cmq per l' html si puo usare /// per il C++/Java /** */ x il C. Ti è sembrato completo com tutorial?
__________________
Gnu/Linux User |
|
27-12-2003, 10:36 | #5 |
Senior Member
Iscritto dal: Oct 2001
Messaggi: 11471
|
A parte i dubbi che che mi erano venuti prima . si l'ho trovato un buon tutorial per un niubbo visto che sono riuscito a fare qualcosa pure io
ciao |
27-12-2003, 10:45 | #6 | |
Senior Member
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
|
Quote:
Posso vedere?
__________________
Gnu/Linux User |
|
27-12-2003, 11:23 | #7 |
Senior Member
Iscritto dal: Oct 2001
Messaggi: 11471
|
|
27-12-2003, 11:27 | #8 |
Senior Member
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
|
cmq la trad italiana nn è il massimo, vero?
__________________
Gnu/Linux User |
27-12-2003, 11:43 | #9 | |
Senior Member
Iscritto dal: Oct 2001
Messaggi: 11471
|
Quote:
ciao |
|
28-12-2003, 17:53 | #10 |
Senior Member
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
|
me lo puoi testare per il java????
Tnk
__________________
Gnu/Linux User |
28-12-2003, 18:20 | #11 |
Senior Member
Iscritto dal: Oct 2001
Messaggi: 11471
|
certo qui c'è l'output di un piccolo esercizio fatto in java che feci qualche tempo fa. http://pigaz.altervista.org/doxy-java.tar.bz2. è piuveloce di javadoc e la documentazione tiene di meno pero il riusultato è un po "incasinato" e non è completo. secondo me si puo ancora migliorare.
ciao |
28-12-2003, 18:40 | #12 |
Senior Member
Iscritto dal: Apr 2002
Città: Vigevano(PV)
Messaggi: 2123
|
meglio di fare tutto a mano.
Cmq e opensource quindi sempre aggiornato
__________________
Gnu/Linux User |
20-07-2005, 11:21 | #13 |
Senior Member
Iscritto dal: Aug 2000
Città: Formia
Messaggi: 6853
|
Azzzz ottimo doxygen
__________________
"La birra è la prova che dio ci ama e vuole che siamo felici" |
19-05-2006, 08:42 | #14 |
Senior Member
Iscritto dal: Oct 2004
Città: Rovereto (tn)
Messaggi: 2187
|
un conisglio per il tutorial:
dovresti aggiungere una breve spiegazione su come inserirei i commenti, se c sono caratteri speciali per avere autore ecc.. ciao |
15-06-2009, 12:53 | #15 |
Junior Member
Iscritto dal: Feb 2006
Città: Padova
Messaggi: 13
|
info-caratteri e colori
Ciao ragazzi,
è un po' che sto bazzicando con il C++ e la creazione della documentazione con doxygen. Sapete come si possono implementare i caratteri e i colori, per sembio bold e rosso? grazie mille
__________________
--- The time is gone the song is over, thought I'd something more to say! cgiocoli |
16-12-2011, 14:54 | #16 |
Member
Iscritto dal: Oct 2007
Messaggi: 38
|
Ciao a tutti, sto provando a usare doxygen, ho scaricato l'ultima versione, con Doxywizard che funge da interfaccia grafica e vorrei usarlo per creare della documentazione dai commenti che ho inserito nel codice... solo che non riesco a capire come devono essrere formattati i commenti visto che il VHDL non usa "/*", "//*" o "///" ma definisce i commenti come frasi precedute da "--".
Qualcuno è in grado di aiutarmi? Grazie mille anticipatamente a tutti! |
03-04-2012, 11:36 | #17 |
Member
Iscritto dal: Mar 2007
Messaggi: 207
|
Grazie!
__________________
Tutti gli imbecilli della Borghesia che pronunciano continuamente le parole: immorale, immoralità, moralità nell’arte e altre bestialità mi fanno pensare a Louise Villedieu, puttana da cinque franchi, che accompagnandomi una volta al Louvre, dove non era mai stata, si mise ad arrossire, a coprirsi la faccia, e tirandomi a ogni momento per la manica, mi domandava davanti alle statue e ai quadri immortali come si potesse esporre pubblicamente simili indecenze. (Charles Baudelaire)
|
Strumenti | |
|
|
Tutti gli orari sono GMT +1. Ora sono le: 14:03.