Qualche preferenza per i programmatori Asp.Net su come documentare il loro codice?
Ho letto XML con Sandcastle è un buon modo per andare. Che cosa usi?
Qualche preferenza per i programmatori Asp.Net su come documentare il loro codice?
Ho letto XML con Sandcastle è un buon modo per andare. Che cosa usi?
XML + GhostDoc + Sandcastle funziona bene quando si sviluppa un'API che richiede documentazione e / o desidera supporto intellisense. Saranno utili a te ea chiunque altro usi ciò che hai costruito, anche se non stanno guardando il tuo codice sorgente. Ciò consente anche di creare collegamenti tra i documenti.
I commenti incorporati sono utili solo a te o ad altri che stanno guardando attraverso il tuo codice sorgente. Hanno un posto e non devono necessariamente essere abbandonati, ma la maggior parte dei commenti inline può essere ovviata favorendo uno stile dichiarativo di codifica su uno stile imperativo e utilizzando variabili descrittive e significative e nomi di membri. Questi possono fare molto per creare un codice di auto-documentazione.
Tale documentazione:
Pur comprendendo che i due non si escludono a vicenda ...
Favor self-documenting code over external documentation.
Leggi altre domande sui tag asp.net documentation-generation