XML Documentation see, seealso tags are of no use in VS.Net and don't want to use NDOC

  • Thread starter Thread starter Sagar
  • Start date Start date
S

Sagar

Hi Friends,

Please forgive me if this question has appeared before. If so
please give me a link or some clue on this problem.
I'm writing XML comments to build Comment Web Pages by using
Tools-->Build Comment Web Pages in VS.Net IDE. I could see <summary>,
<remarks>, <param> etc in the resultant web pages. But there is no
trace of <see>, <seealso>. They just seem to be missing, even if they
are present in the XML. I'm not getting any help on web also, and most
of them are suggesting to use NDOC, which gives too much extensive
documentation.

So I want to confirm whether VS.Net supports those tags or not(If not
its very strange)? Or is there any way we can customize the behaviour?
May be by editing default .Xsl file if there is any. Or Is there any
other tool like NDOC which gives minimal and/but customizable
documentation.

Please help me. This is very urgent.
Thanks in advance.

Regards,
Sagar
 
Well you can still use VS.NET and/or NDoc to create the Xml output and then
write your own custom Xsl stylesheet which you could then apply using a very
simple C# application. I think using NDoc to generate the Xml *might* help
you out some (with linking see and seealso tag).

You could even copy the NDoc stylesheet as a starting point and remove
whatever it is that you don't want in your documentation.
 
Well one way to change the appearance of the MSDN docs generated by NDoc is
to modify the CSS that it uses. It is in the NDoc directory and is named
"MSDN.css." If you want to have more control then you'll have to check out
the NDoc source code (or download the latest release canidate which has the
source code with it as well, I believe) and muck with it by hand.

Or you could just roll your own stylesheet by hand to process the existing
Xml comment files. Whatever suits your needs.
 
Back
Top