c# - fuente - generar documentacion visual studio 2017
¿Existe un estándar(como phpdoc o python''s docstring) para comentar el código C#? (6)
C # tiene comandos de documentación integrados : msdn link ¡ Diviértete!
¿Existe una convención estándar (como phpdoc o python''s docstring) para comentar el código C # para que la documentación de la clase pueda generarse automáticamente a partir del código fuente?
Las respuestas anteriores señalan perfectamente la sintaxis XML. Solo quería presentar mi recomendación para el generador de la biblioteca de ayuda nDoc gratuita (y de código abierto) que analiza todos los comentarios en un proyecto.
Microsoft usa " Comentarios de documentación XML " que proporcionarán descripciones IDE intellisense y también le permitirán generar automáticamente la documentación de estilo MSDN utilizando una herramienta como Sandcastle si activa la generación de la salida del archivo XML.
Para activar la generación del archivo XML para la documentación, haga clic con el botón derecho en un proyecto en Visual Studio, haga clic en "Propiedades" y vaya a la pestaña "Crear". Hacia la parte inferior puede especificar una ubicación para su archivo de salida de comentarios XML.
Puede usar comentarios de estilo XML y usar herramientas para sacar esos comentarios a la documentación de la API.
Aquí hay un ejemplo del estilo de comentario:
/// <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 proporciona una sola tecla de método abreviado para generar automáticamente comentarios para una clase o método. Sandcastle , que genera documentación de estilo MSDN a partir de comentarios XML.
/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>
Siempre me dijeron que utilizara los comentarios de bloque abiertos con 2 o más asteriscos para delimitar los comentarios de la documentación.
/**
Documentation goes here.
(flowerboxes optional)
*/