vb.net comments to developer documentation

  • Thread starter Thread starter Guest
  • Start date Start date
G

Guest

I see that a few people on this board are recommending VB Commenter. It works well as far as getting a comment structure in my code, but what about generating the proper code docs? I've tried NDoc. It seems to generate some, but not all of my documentation

For example, it is not generating the comments within the <value> tag which I am using to document my properties and the <summary> tag for methods. The only thing it seems to be generating is the <summary> tag for my classes

Are they any other tools that I can use

Thanx.
 
NDoc includes many tags and we can include these tags into our comments
something like <SeeAlso>...etc is support and it works fine with NDoc

Hope it helps~


Michael A. Angelo said:
I see that a few people on this board are recommending VB Commenter. It
Click to expand...
works well as far as getting a comment structure in my code, but what about
generating the proper code docs? I've tried NDoc. It seems to generate some,
but not all of my documentation.
For example, it is not generating the comments within the <value> tag
Click to expand...
which I am using to document my properties and the <summary> tag for
 
I understand that is does include many tags. It tells me to use the <value> tag for properties and the <summary> tag for methods. I've done this and neither of these comments are being generated. The only comments that are generated are the <summary> tags at the class level.
 
Back
Top