是否有一个标准(如phpdoc或python的文档字符串)用于注释C#代码？
是否有一个标准(如phpdoc或python的文档字符串)用于注释C#代码？
提问于 2008-08-29 15:57:45
是否有用于注释C#代码的标准约定(如phpdoc或python的docstring)，以便可以从源代码自动生成类文档？
回答 6
Stack Overflow用户
回答已采纳
发布于 2008-08-29 16:02:40
您可以使用XML样式注释，并使用工具将这些注释提取到API文档中。
以下是注释样式的示例：
/// <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)促进这一点的一些项目包括：
GhostDoc，它提供了一个快捷键来自动生成类或方法的注释。从Sandcastle注释生成MSDN样式的文档。
Stack Overflow用户
发布于 2008-08-29 16:01:37
/// <summary>
///
/// </summary>
/// <param name="strFilePath"></param>Stack Overflow用户
发布于 2008-08-29 16:01:59
C#内置了documentation commands，祝你玩得开心！
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/34516
复制相关文章
相似问题