CODEWITHSUNDEEP
visual-studiopluginscomments
Germstorm
Germstorm

Reputation: 9839

Automatically adding .Net code comments

Where can I find a Visual Studio plug-in that automatically generates documentation header for methods and properties?

Example the comment to a property could look like this:

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

   set
   {
       message = value;
   }
}

Upvotes: 1

Views: 2801

Answers (3)

Reputation:

GhostDoc is the usual suspect.

As another poster mentioned, Visual Studio also does this to an extent by entering 3 '///' (forward slashes) on the line preceding a property/method/class definition.

Upvotes: 4

Matthew
Matthew

Reputation: 2072

Visual Studio does this automatically. Just position the cursor directly above the method and enter three '/'s for example:

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;
        }
    }
}

You can then generate an XML comment file and then generate a Help file using SandCastle.

You may have to enable this feature in the Text Editor/C#/Advanced options dialog.

Upvotes: 3

to StackOverflow
to StackOverflow

Reputation: 124696

Ghostdoc from http://www.roland-weigelt.de/ghostdoc/

Upvotes: 8

Related Questions