Comments and Project Documentation

[pathfinder264]

Hello, I had two questions:
1) Does anyone know if VB.NET has an equivalent to Java's Javadoc?

2) How do you comment a sub procedure or method so that in the Object browser when viewing the method or sub procedure the "summary" or description of the sub procedure is displayed?

 

[jmcilhinney]

1) C# has automatic XML documentation that VB.NET lacks in .NET 1.1. This has been remedied in .NET 2.0 but for the moment you can download a VS.NET add-in that does a similar job from http://www.gotdotnet.com/workspaces/releases/viewuploads.aspx?id=112b5449-f702-46e2-87fa-86bdf39a17dd.

2) You need to add a Description attribute to your method like so:

[color=Blue]Imports[/color] System.ComponentModel

[color=Blue] Public Class[/color] MyClass

	<Description("This is the description of MyProcedure.")> [color=Blue]Public Sub[/color] MyProcedure()
		[color=Green]'...[/color]
	[color=Blue]End Sub[/color]

[color=Blue] End Class[/color]

 

[pathfinder264]

Cool! Thanks jmcilhinney, you are a genius! I was going to rewrite my code to C# but not anymore!