是否有用于注释Ccode的标准约定(例如phpdoc或者python的docstring)，以便可以从源代码自动生成类文档？

解决方案

回答

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

http://msdn.microsoft.com/zh-CN/magazine/cc302121.aspx

回答

内置文档命令的Chas
玩得开心！

回答

我们可以使用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样式的文档。

回答

Microsoft使用" XML文档注释"，该注释将提供IDE的智能提示描述，并且如果我们打开XML文件输出的生成，还允许我们使用诸如Sandcastle之类的工具自动生成MSDN样式的文档。

要打开用于文档的XML文件的生成，请在Visual Studio中右键单击一个项目，单击"属性"，然后转到"构建"选项卡。我们可以在底部指定XML注释输出文件的位置。

回答

前面的答案完美地指出了XML语法。我只是想提出免费(开源)nDoc帮助库生成器的建议，该生成器可解析项目中的所有注释。

回答

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

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