visual-studio - 自动添加 .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#/高级选项对话框中启用此功能。