Showing posts with label Documentation. Show all posts
Showing posts with label Documentation. Show all posts

Thursday, August 24, 2006

GhostDoc

GhostDoc is a free add-in for Visual Studio that automatically generates XMLdocumentation comments for C#.

After you have installed the software, just move the cursor into properties and methods and call the "Document this" command either using the context menu or by pressing the hotkey (if you assigned one).

Here is a sample, where all the comment is generated by GhostDoc:

/// <summary> 

/// Initializes a new instance of the class. 

/// </summary> 

/// <param>name="id": The id.</param> 

/// <param> name="name": The name. </param> 

/// <param> name="latitude": The latitude. </param> 

/// <param> name="longitude": The longitude. </param>

/// <param> name="category": The category. </param>

/// <param> name="imageUrl": The image URL. </param>

/// <param> name="infoURL": The more info URL. </param> 

/// <param> name="description": The description. </param> 

public void MapItemRow(int id, string name, double latitude, double longitude, string category, string imageUrl, string moreInfoUrl, string description)

{ }

Sunday, August 13, 2006

Microsoft Sandcastle - 'NDoc by Microsoft'

Easy generated Source Code Documentation out of the xml-comments is now possible with the new MS Tool Sandcastle. Till now, NDoc was the first joice for me. But Sandcastle sounds like a real alternative - especially because of real .NET 2.0 support.

Mission Statement:
Enable managed class library developers throughout the world to easily create accurate, informative documentation with a common look and feel.

Sandcastle is used internally to build .Net Framework documentation.

Sandcastle Overview:

  • Produces quality, comprehensive, familiar MSDN-like documentation.
  • Works with or without authored comments.
  • Supports Generics and .NET Framework 2.0
  • Sandcastle MrefBuilder generates reflection xml file
  • Sandcastle Build Assembler includes syntax generation, transformation..etc

Sandcastle Blog, Sandcastle Download