.Net Comment

[elefrancois]

Hi,
I heard somewhere about a new things that the VS.NET environment is suppose to provide. A template to define comments in your code to generate html documentation automaticaly. Does it really exist or it's just a "vaperware" ?

Thanks


Etienne

[s_engle]

There is a builtin version of a JavaDoc style documentation mechanism that generates HTML pages documenting your code. In the beta it doesn't seem to be functional for C++ projects, I understand that it does work for C# projects.

[elefrancois]

Ok, I see. I know JavaDoc style documentation.
Some thing like this could be be enought for me. Do you know where I can find out the template for the comments. Even if it's only for C# project.

BTW, I also heard (yes, with MS technologies we often say "Heard" :-)) that is also a XML template for comments.
It would be nice cause what we are looking at is doing a big XML doc that we gonna applies to some XSLT files to generate defferent type of documentation... Did you heard about that ?

Thanks

Etienne

[s_engle]

My apologies, I think my earlier post is wrong.

It looks like you are correct, there is a processor, actuated by the /DOC option that processes your tags into an XML file. The processor seems to mostly just pass your tags on through to the output XML file, adding some additional context regarding which function in which class it corresponds to. There are some recommended tags, but you are generally free to structure it as you wish.

There are, however, several JavaDoc style clones out there, some for free.