473,386 Members | 2,050 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,386 software developers and data experts.

vb.net comments to developer documentation

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.
Nov 20 '05 #1
3 1234
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" <mi********@usa.net> ¦b¶l¥ó
news:C1**********************************@microsof t.com ¤¤¼¶¼g...
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.

Nov 20 '05 #2
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.
Nov 20 '05 #3
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.
Nov 20 '05 #4

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

28
by: Benjamin Niemann | last post by:
Hello, I've been just investigating IE conditional comments - hiding things from non-IE/Win browsers is easy, but I wanted to know, if it's possible to hide code from IE/Win browsers. I found...
6
by: Clive Dixon | last post by:
Q1: The intellisense summary info for a class only seems to update after a change to that class's XML comments if I remove the reference to the project from the current project and add it back...
6
by: Clive Dixon | last post by:
It's a bit of a PITA to duplicate XML comments in such a scenario as where you want to give a class method implementing an interface method exactly the same documentation (or part thereof) as the...
40
by: Edward Elliott | last post by:
At the risk of flogging a dead horse, I'm wondering why Python doesn't have any multiline comments. One can abuse triple-quotes for that purpose, but that's obviously not what it's for and doesn't...
1
by: digitalshehan | last post by:
Does anyone know how I can configure Visual Studio 2003 so that missing XML documentation comments/tags are displayed as warnings when I compile a C# project? Thanks!
98
by: tjb | last post by:
I often see code like this: /// <summary> /// Removes a node. /// </summary> /// <param name="node">The node to remove.</param> public void RemoveNode(Node node) { <...> }
0
by: Gennaro Prota | last post by:
Hi, after several "tweaks" I think I've finally found a file layout which I like for my code (in terms of where the copyright line and the license reference go, where the vim modeline etc.). For...
0
by: taylorcarr | last post by:
A Canon printer is a smart device known for being advanced, efficient, and reliable. It is designed for home, office, and hybrid workspace use and can also be used for a variety of purposes. However,...
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: ryjfgjl | last post by:
If we have dozens or hundreds of excel to import into the database, if we use the excel import function provided by database editors such as navicat, it will be extremely tedious and time-consuming...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
0
BarryA
by: BarryA | last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.