Hay un estándar (como phpdoc o python docstring) para la presentación de comentarios de código de C#?

Question

Hay una convención estándar (como phpdoc o python docstring) para la presentación de comentarios de código en C# para que toda la clase puede ser generado automáticamente a partir del código fuente?

Answer 1

Puede utilizar XML comentarios del estilo, y el uso de herramientas para tirar de los comentarios en la documentación de la API.

Aquí es un ejemplo de comentario del estilo:

/// <summary>
/// Authenticates a user based on a username and password.
/// </summary>
/// <param name="username">The username.</param>
/// <param name="password">The password.</param>
/// <returns>
/// True, if authentication is successful, otherwise False.
/// </returns>
/// <remarks>
/// For use with local systems
/// </remarks>
public override bool Authenticate(string username, string password)

Algunos elementos para facilitar esto son:

GhostDoc, que dan una sola tecla de acceso directo para generar automáticamente los comentarios de una clase o método.Castillos de arena, lo que se genera MSDN estilo de documentación de los comentarios XML.

Answer 2

/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>

http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 3

Microsoft usa "Comentarios de Documentación XML"que dará IDE intellisense descripciones y también permite generar de forma automática MSDN-estilo de documentación utilizando una herramienta como castillos de arena, si usted enciende la generación del archivo XML de salida.

A su vez en la generación del archivo XML para la documentación, haga clic derecho en un proyecto en visual studio, haga clic en "Propiedades" y vaya a la "construcción" de la ficha.Hacia la parte inferior, usted puede especificar una ubicación para sus comentarios XML del archivo de salida.

Answer 4

Las respuestas anteriores señalan la sintaxis de XML a la perfección.Yo sólo quería tirar mi recomendación para el libre (y de código abierto) nDoc de la biblioteca de ayuda del generador que analiza todos los comentarios en un proyecto.

Answer 5

C# se ha construido en la documentación de los comandos Divertirse!

Answer 6

Siempre me han dicho que el uso de comentarios en bloque abierto con 2 o más asteriscos delimitar comentarios de documentación.

/**
Documentation goes here.
(flowerboxes optional) 
*/