PDA

View Full Version : [c# 2.0] Generazione automatica della documentazione partendo dai commenti

zebrone
18-10-2006, 11:33
Ho concluso lo sviluppo di un'applicativo con visual c# 2.0 e vorrei generare automaticamente la documentazione partendo dai commenti che ho inserito all'interno del codice.
Esiste un modo di farlo direttamente da VS2005 o devo utilizzare tool esterni? (ho visto che c'è ndoc ma supporta .net 1.0 e 1.1 ma non 2.0)
VICIUS
18-10-2006, 11:41
Qui puoi trovare una versione modificata di ndoc che funziona con .NET 2.0 http://jonas.lagerblad.com/blog/?p=4

ciao ;)
zebrone
18-10-2006, 12:26
Grazie l'avevo già provata ma purtroppo ha qualche problema, quasi tutte le tipologie di documentazione tra cui si può scegliere mi danno delle eccezioni mentre le poche che concludono l'esportazione genereano file con solo i nomi di classi, metodi e variabili senza però i miei commenti :mc:
zebrone
18-10-2006, 12:47
Per ora ho scoperto questo: all'interno di VS2005 selezionando la soluzione e facendo tasto destro > proprietà in fondo al tab Build c'è una voce "XML documentation file" che compilando in Debug mode permette di esportare tutti i commenti in un unico file XML. E' meglio di niente però a questo punto per presentarlo in maniera decente bisogna scriversi un xsl :cry:
dupa
18-10-2006, 13:43
Ho concluso lo sviluppo di un'applicativo con visual c# 2.0 e vorrei generare automaticamente la documentazione partendo dai commenti che ho inserito all'interno del codice.
Esiste un modo di farlo direttamente da VS2005 o devo utilizzare tool esterni? (ho visto che c'è ndoc ma supporta .net 1.0 e 1.1 ma non 2.0)

non so come funziona .net
però in java per usare la javadoc, devi commentare i singoli metodi e attributi secondo un certo stile formale.. in modo tale che poi il compilatore della javadoc possa generarti i file html in automatico.
in sostanza se scrivi:

// assegno pippo
pippo = 5;

Non è che poi te lo ritrovi nella javadoc ;)
zebrone
18-10-2006, 14:02
Continuando l'approccio del file xml esportato da VS2005 ho trovato anche un xsl già pronto per l'uso; è un po' spartano ma con piccole modifiche si può ottenere un risultato soddisfacente link (http://www.codeproject.com/soap/XMLDocStylesheet.asp)