Best practice per documentare il codice ASP.NET [chiuso]

0

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?

    
posta TeaDrinkingGeek 16.02.2011 - 10:33
fonte

2 risposte

1

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.

    
risposta data 19.02.2011 - 05:34
fonte
1

Tale documentazione:

  1. Diventa obsoleto
  2. Diventa eccessivamente costoso da mantenere nel tempo.

Pur comprendendo che i due non si escludono a vicenda ...

Favor self-documenting code over external documentation.

    
risposta data 19.02.2011 - 17:19
fonte

Leggi altre domande sui tag