Ejemplos de documentación de código

Bueno yo no sé que tan buenas son mis practicas pero aquí te las proveo con
mucho gusto:

1. En todo programa, módulo, etc., utilizo un encabezado ("header") que
contiene información del programa y además contiene información que Visual
SourceSafe estampa en el código automaticamente (como la versión actual,
fecha de guardado, etc.). Este es le encabezado que utilizo yo:

#region Version Header
/// <remarks>
/// $Workfile: MiCodigo.cs $
/// Description: Descripción va aquí.
/// Author: Jose Luis Manners Docs: Jose Luis Manners
/// Created: 06/14/2004 13:18:59pm
/// $Modtime: 06/25/2004 14:23:22pm $
/// $Revision: 3 $
/// Copyright: © 2004 ABC Company
/// </remarks>
#endregion

Lamentablemente aquí en este mensaje no sale propiamente formateado como
saldría en Visual Studio. Y por supuesto, tengo un macro de VS que añade el
encabezado automaticamente.

2. Utilizo una herramienta llamada NDoc para generar archivos de ayuda como
los de MSDN y Visual Studio.

3. Utilizo comentarios XML para las funciones/propiedades. Como por ejemplo:

/// <summary>
/// Establece/devuelve el máximo número de digitos enteros.
/// </summary>
/// <remarks>
/// Esta propiedad no acepta valores menores de 1.
/// </remarks>
/// <seealso cref="MaximoNumeroDeDecimales"/>
[Description("Establece/devuelve el máximo número de digitos enteros.")]
[Category("Behavior")]
public int MaximoNumeroDeEnteros
{
}

Bueno espero que esto te de una idea.
Saludos,

Jose Luis Manners, MCP

"MIguel Angel Ortiz" wrote in message
news:2189801c45ae5$aa3d4810$
Hola grup soy nuevo en .NET y quisiera saber si alguno de
ustedes me podría proveer ejemplos de buenas prácticas de
documentación de código.

Gracias de antemano.