Il blog di Sandro Rizzetto

Sandcastle e affini...

 

Era ora che mi prendessi un po' di tempo per guardare l'applicazione in eterna fase di beta (siamo alla n-esima CTP, non è un buon segno) per generare la documentazione di un progetto... Ero pronto a imbarcarmi in un'odissea di file batch come avevo letto e sentito da Rob, ma prima ho provato a googlare Sandcastle+GUI (mi sto impigrendo) ed ho trovato questo che mi sembra ottimo prodotto freeware Sandcastle Help File Builder. Con pochi colpi di clic si genera un chm di ottima fattura.

Ora il problema sta nello sforzarsi a scrivere gli Xml Comments del proprio codice... Un buon aiuto viene da quest'altro tool free (Ghostdoc), un add-in di VS2005 che permette di generare in modo automatico gli xml comment delle proprie classi, metodi, proprietà (solo c#) deducendoli dai nomi usati... ringrazio chi (Paolo e questo libro) mi ha insegnato a usare sempre l'inglese e una nomenclatura rigorosa (es. il pascal/camelcase, le iniziali minuscole per i parametri, l'underscore per le private, ecc) in quanto il tool con questo tipo di nomenclatura non fa miracoli ma riesce a fare bene il lavoro iniziale sporco e noioso.

Aggiungi Commento

Copyright © 1997-2017 Sandro Rizzetto | All Rights Reserved | Riproduzione delle fotografie vietata | Powered by me