是否有一个标准(如phpdoc或蟒蛇的文档字符串)的评论C#代码？

Question

是否有一个标准公约》(如phpdoc或蟒蛇的文档字符串)的评论C#代码，以便这类文件可以是自动产生的源代码？

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, ，这给一个单快捷键自动地产生意见对于一类或方法。沙塔, ，其产生的MSDN式文件从XML意见。

Answer 2

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

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

Answer 3

Microsoft使用"XML文件的评论"这将给IDE intellisense说明和还允许自动产生MSDN式文件使用的工具，如Sandcastle如果你打开一代的XML文件的输出。

开启一代的XML文件的文档，对击中的一个项目visual studio，点击"属性"和进入"建立"选项。朝底，你可以指定一个位置你的XML意见的输出文件。

Answer 4

前面的答复指出XML语法。我只是想扔我的建议 免费(和开放源码)nDoc帮助图书馆发生器 分析的所有评论意见在一个项目。

Answer 5

C#已经建立在 文件的命令 玩得开心！

Answer 6

我总是告诉过使用框意见打开有2个或多个星号做的划定文件的评论意见。

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