[Tutorial] Doxygen
1 Allegato(i)
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> 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 |
Piccolo consiglio, lasciate la lingua di default perche la traduzione di ora nn mi sembra il maximo.
Ciao e aspetto feedback :) |
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 ;) |
Quote:
Cmq per l' html si puo usare /// per il C++/Java /** */ x il C. Ti è sembrato completo com tutorial? |
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 :D
ciao ;) |
Quote:
Posso vedere? |
|
cmq la trad italiana nn è il massimo, vero?
|
Quote:
ciao ;) |
me lo puoi testare per il java????
Tnk |
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 ;) |
meglio di fare tutto a mano.
Cmq e opensource quindi sempre aggiornato :) |
Azzzz ottimo doxygen :)
|
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 |
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 |
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! |
Grazie!
|
Tutti gli orari sono GMT +1. Ora sono le: 05:40. |
Powered by vBulletin® Version 3.6.4
Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
Hardware Upgrade S.r.l.