是否有用于评论C#代码的标准(如phpdoc或python的docstring)?
是否有标准约定(如phpdoc或python的docstring)用于注释C#代码,以便可以从源代码自动生成类文档?
您可以使用XML样式注释,并使用工具将这些注释提取到API文档中。
以下是评论样式的示例:
/// /// Authenticates a user based on a username and password. /// /// The username. /// The password. /// /// True, if authentication is successful, otherwise False. /// /// /// For use with local systems /// public override bool Authenticate(string username, string password)
一些便于此的项目是:
GhostDoc ,它提供单个快捷键以自动为类或方法生成注释。 Sandcastle ,从XML注释生成MSDN样式文档。
/// /// /// ///
Microsoft使用“ XML文档注释 ”,它将提供IDE智能感知描述,并允许您使用Sandcastle等工具自动生成MSDN样式的文档,如果您打开XML文件输出的生成。
要打开文档生成XML文件,右键单击visual studio中的项目,单击“属性”,然后转到“生成”选项卡。 在底部,您可以指定XML注释输出文件的位置。
前面的答案完美地指出了XML语法。 我只是想提出一个解析项目中所有注释的免费(和开源)nDoc帮助库生成器的建议。
我总是被告知要使用以2个或更多星号打开的块注释来划定文档注释。
/** Documentation goes here. (flowerboxes optional) */
C#内置文档命令玩得开心!