is there anything is asp.net for documenting classes like javadoc

[mit99mh]

I'm sorry if post like this have appeared before but I'm new to asp.net (using vb.net) and something like the above would be useful

thanks

 

[jfrost10]

I have no clue what JavaDoc is, but I'll share what we do for comments in our classes:

In .NET you can create something called a Region. In your code behind, you basically do this:

#Region "Comments

#End Region

What this does is create an expandable node within your code that can store data! We have one for comments, one for declarations, one for properties, and one for the actual class code in each class.

This way, you can put as much documentation as you want within the class file itself, but only see it when you want to.

hth

D'Arcy

 

[alexboly]

There is such thing, but the documentation says it is only for C#...
Well, I will go on explaining it. You can place before beginning of classes, before events, properties, methods, delegates, interfaces and namespaces some special comments, prefixed with ///. You can use some tags in this comments; they are documented in MSDN (search for "Tags for documentation comments&quot. Then, by using the compiler option /doc:file, you can generate the XML documentation for your project (this can be done also from your project's properties).
As I said, it is unfortunate that it works only for C#, or at least MSDN says so...

 

[mit99mh]

thanks for both your help