XML Comments that DO NOT WORK !!!

  • Thread starter Thread starter gary hitch
  • Start date Start date
G

gary hitch

Trying to generate html documentation with the built-in Build Comment Web
pages tool of .Net

Many of the comments are simply eliminated in the results files

such as : /// <exception cref="System.Exception">Thrown when bla bla
bla</exception>

Anyone got any ideas ?

I need to build doc files for a delivrable this week

Thanks

8-)
 
gary said:
Trying to generate html documentation with the built-in Build Comment
Web pages tool of .Net

I need to build doc files for a delivrable this week
Click to expand...

I would recommend to use the ndoc-tool.
This will generate very good help-files in different format (CHM, Help2,
HTML, ...) from the XML-docu in the source and the (reflected) assembly.



See:
http://ndoc.sourceforge.net/


Download from:
http://sourceforge.net/project/showfiles.php?group_id=36057&release_id=17
4231

--
Greetings
Jochen

Do you need a memory-leak finder ?
http://www.codeproject.com/tools/leakfinder.asp

Do you need daily reports from your server?
http://sourceforge.net/projects/srvreport/
 
To augment the other good response about ndoc, I discovered the hard way too
that the built-in documentation building only recognizes a very small subset
of the available tags. It can be quite confusing because the help regarding
comments gives you all kinds of them, but then the actual documentation
builder only uses 3 or 4. Somewhere I found a list of the recognized tags,
but I don't know where.

From what I can tell ndoc seems be about the de facto standard for
developing help files from code comments.
 
Back
Top