Автоматическое добавление комментариев .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

Ghostdoc от http://www.roland -weigelt.de / 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 # / Дополнительные параметры».