Commenting for document generator

[Velvet]

I have been developing ASP.NET applications. In 1.1 I added a <remark> tag
for each class and inside it I added my modification history (HTML
formatted). With the built-in function that allowed me to build web docs
from my comments, this would appear in the generated documentation. This
worked pretty well for the web docs.

VS 2005 no longer has a built-in doc generator so I'm not sure what to use
to build my docs now. I was told previously that NDoc would be the
generator that I want, but it is not and will not be available for 2.0.
(It's effectively dead). So what programs are people using for 2.0 now?

Also, I would like to know if people are adding a Modification History to
their class files and in what tag is it included so that it will be
available in the generated docs?

Thanks in advance,
Velvet

 

[news.microsoft.com]

The reason Ndoc is no longer actively being developed is that Microsoft has
been working on and recently released a project for generating MSDN style
documentation called "Sandcastle". You can download the CTP from December
at:

http://www.microsoft.com/downloads/...1D-DA89-42EE-A715-696E3A4873B2&displaylang=en

The CTP is difficult to use as it has no GUI, but there is a rather nice
implementation of a GUI for it located at:

http://codeplex.com/SHFB

 

[Walter Wang [MSFT]]

Hi Velvet,

As jparrish stated, Sandcastle is the preferred tool to generate
documentation for VS2005. Please feel free to reply here if you need more
information on this.

Regards,
Walter Wang ([email protected], remove 'online.')
Microsoft Online Community Support

==================================================
When responding to posts, please "Reply to Group" via your newsreader so
that others may learn and benefit from your issue.
==================================================

This posting is provided "AS IS" with no warranties, and confers no rights.