This post originated from an RSS feed registered with .NET Buzz by Jeff Key. Original Post: Documentation for the masses Feed Title: Jeff Key Feed URL: http://www.asp.net/err404.htm?aspxerrorpath=/jkey/Rss.aspx Feed Description: Topics revolve around .NET and the Windows platform. Latest .NET Buzz Posts Latest .NET Buzz Posts by Jeff Key Latest Posts From Jeff Key

Fire up your "must install on new development machine" list and get ready to add something else.

Matt pointed me to an amazing little Visual Studio add-in called GhostDoc that produces amazingly accurate starter documentation for type members. Simply put the cursor on the member, press the hotkey and change the result, if required. A demo class is included that illustrates this perfectly. (All of these comments were generated automagically.)

 /// <summary> 
 /// Gets the current directory. 
 /// </summary> 
 /// <returns></returns> 
 public string GetCurrentDirectory() 
 
 /// <summary> 
 /// Does something. 
 /// </summary> 
 public void DoSomething() 
 
 /// <summary> 
 /// Builds the HTML text. 
 /// </summary> 
 /// <returns></returns> 
 public string BuildHtmlText() 
 
 /// <summary> 
 /// Initializes the GUI. 
 /// </summary> 
 public void InitializeGui() 
 
 /// <summary> 
 /// Determines the size of the page buffer. 
 /// </summary> 
 /// <param name="initialPageBufferSize">Size of the initial page buffer.</param> 
 /// <returns></returns> 
 public int DeterminePageBufferSize(int initialPageBufferSize) 
 
 /// <summary> 
 /// Performs some action. 
 /// </summary> 
 public void PerformSomeAction() 
 
 /// <summary> 
 /// Gets or sets a value indicating whether this <see cref="Demo"/> is cool. 
 /// </summary> 
 /// <value> 
 /// <c>true</c> if cool; otherwise, <c>false</c>. 
 /// </value> 
 public bool Cool 
 { 
 get { return true; } 
 set { ; } 
 } 
 
 /// <summary> 
 /// Gets a value indicating whether [just testing]. 
 /// </summary> 
 /// <value> 
 /// <c>true</c> if [just testing]; otherwise, <c>false</c>. 
 /// </value> 
 public bool JustTesting 
 { 
 get { return true; } 
 } 
 
 /// <summary> 
 /// Gets the <see cref="System.String"/> with the specified index. 
 /// </summary> 
 /// <value></value> 
 public string this[int index] 
 { 
 get { return null; } 
 } 

How cool is that?!