E’ molto più semplice di quanto si pensi implementare una corretta documentazione del codice.

NDoc (http://ndoc.sourceforge.net/) è solo una delle soluzioni possibili, ma certamente una delle migliori. Permette di creare documentazione HTML (o anche CHM) in pochi click con differenti stili grafici (MSDN, Java, …).

E' sufficiente abilitare in Visual Studio .NET la creazione dei file XML di Documentazione in questo modo:

  1. Aprire le proprietà del progetto
  2. Aprire il menù Proprietà di configurazione -> Generazione
  3. Impostare un percorso all'interno di File di documentazione XML

A questo punto bastano pochi accorgimenti nella scrittura dei commenti per creare un ottima documentazione utile prima di tutto per manutenere il codice ed in secondo luogo per permettere anche ad altri di modificare e migliorare il nostro codice.

Questo è un esempio molto semplice: 

public class MyClass() 
{ 
  ///  
  /// Descrizione della classe
  ///  
  /// Descrizione del parametro s 
  public MyClass( string s ) { } 
}