c# - 是否有用于注释 C# 代码的标准（如 phpdoc 或 python 的文档字符串）？

Question

是否有用于注释 C# 代码的标准约定（如 phpdoc 或 python 的文档字符串），以便可以从源代码自动生成类文档？

Answer 1

您可以使用 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，它从 XML 注释生成 MSDN 样式文档。

Answer 2

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

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

Answer 3

C# 内置了文档命令 玩得开心！

Answer 4

Microsoft 使用“ XML 文档注释”，这将提供 IDE 智能感知描述，如果您打开 XML 文件输出的生成，还允许您使用 Sandcastle 等工具自动生成 MSDN 样式的文档。

要为文档打开 XML 文件的生成，请右键单击 Visual Studio 中的项目，单击“属性”并转到“构建”选项卡。在底部，您可以指定 XML 注释输出文件的位置。

Answer 5

前面的答案完美地指出了 XML 语法。我只是想提出我对免费（和开源）nDoc 帮助库生成器的推荐，它可以解析项目中的所有评论。

Answer 6

我总是被告知要使用以 2 个或更多星号打开的块注释来分隔文档注释。

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