自动添加.Net代码注释

Question

在哪里可以找到自动为方法和属性生成文档头的Visual Studio插件？

例如，属性的注释可能如下所示：

/// <summary>
/// Gets or sets the value of message
/// </summary>
public static string Message        
{
   get
   {
       return message;
   }

   set
   {
       message = value;
   }
}

Answer 1

来自http://www.roland-weigelt.de/ghostdoc/的Ghostdoc

Answer 2

GhostDoc是最常见的嫌犯。

正如另一个发帖者提到的，Visual Studio在某种程度上也是通过在属性/方法/类定义之前的行上输入3‘/’(正斜杠)来做到这一点的。

Answer 3

Visual Studio会自动执行此操作。只需将光标放在方法的正上方，然后输入三个‘/’，例如：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace MvcWidgets.Models
{
    /// <summary>
    /// This is a summary comment
    /// </summary>
    public class Comment
    {
        /// <summary>
        /// 
        /// </summary>
        /// <param name="name"></param>
        /// <param name="birthdate"></param>
        /// <param name="website"></param>
        /// <returns></returns>
        public int SomeMethod(string name, DateTime birthdate, Uri website)
        {
            return 0;
        }
    }
}

然后，您可以生成XML注释文件，然后使用SandCastle生成帮助文件。

您可能需要在文本编辑器/C#/高级选项对话框中启用此功能。