Ramon Torras

TECHNOLOGY ENTHUSIAST

Please, comment the code

 

You can comment your code in several ways.

 

You can use the feature we have by default with Visual Studio.

(Three slashes: /// in C# or three colons: ”’ in VB)

 

This feature helps to comment classes, functions, properties, etc…

There is available a plugin for Visual Studio called GhostDoc which uses the same principle but adds more valuable content.

 

Please see the differences in the following screenshots.

 

By default (///)


 

Using GhostDoc (Control+Shift+ d)


 

 

With the payment version you can get more features like, comment all the functions of a class automatically and generate a preview of the help file.

 

You can download it and check how useful is.

http://visualstudiogallery.msdn.microsoft.com/46A20578-F0D5-4B1E-B55D-F001A6345748