评论风格（即Javadocing C＃版本）-（Java开发者学习C＃）

Question

我正在完成一些我的第一个C＃类，尽管继承的原始代码完全没有注释，但是在编写Java时，我总是在我的方法上放置javadoc注释，并且目前没有这些块，我的代码看起来很奇怪。

我通常使用Eclipse中的“ Insert JavaDoc”命令来格式化我的注释，该命令只是布局模板并从运行该命令的方法中提取参数，方法名称等。 然后，我可以从那里添加更多细节。

Visual Studio 2008中是否有类似的命令？ 我在菜单上闲逛时找不到一个。 另外，在C＃世界中是否存在注释样式的标准约定（类似于JavaDoc）？

Answer 1

如果键入/// ，IDE编辑器将自动为您生成一个空的XML注释。

这个：

///
public QName(String qName, XmlNode contextNode) {

变成这个：

/// <summary>
/// 
/// </summary>
/// <param name="qName"></param>
/// <param name="contextNode"></param>
public QName(String qName, XmlNode contextNode) {

如果您的方法抛出任何异常，则您必须手动添加标签，因为.NET没有声明的异常。 最后评论：

/// <summary>Creates a new QName from a string with the format
/// <c>prefix:local-name</c> or <c>local-name</c>.</summary>
/// 
/// <param name="qName">A QName string.</param>
/// <param name="contextNode">An XML node from which to lookup the namespace
/// prefix, or <c>null</c>.</param>
/// 
/// <exception cref="XmlInvalidPrefixException">Thrown if the prefix cannot be
/// resolved from the lookup node. If <paramref name="contextNode"/> is
/// <c>null</c>, then the only prefix that can be resolved is <c>xml</c>.
/// </exception>
public QName(String qName, XmlNode contextNode) {

Answer 2

在任何方法之前键入三个正斜杠：

///

这将生成一个XML注释块。

Answer 3

如果在Visual Studio中的方法之前键入三个正斜杠“ ///”，它将自动创建一个简单的模板供您注释方法。 （它还将创建供您注释参数和返回值的字段。）我认为这很好，因为它既快速又简单，但是您可能需要更深入的信息。

Answer 4

在C＃中，如果在要注释的内容上方输入三个斜杠，它将自动为目标插入适当的文本。

它将包括摘要，参数（如果有），返回（如果有）等。

///

然后，您可以使用类似NDoc的名称来获取这些注释并构建API文档。

Answer 5

Visual Studio有一个免费的插件GhostDoc ，它可以帮助您创建C＃XML文档的基本结构，并提供///以外的更多功能。

Answer 6

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

整个功能称为xml-doc，您可以在Google上搜索很多示例。