XML documentation

Thread view:

Enable EMail Alerts

Start New Thread

Thread rating:

Lloyd Dupont - 24 Jul 2003 23:57 GMT

I have generated my XML documentation.
now what ?
because the XML file is not quite human friendly....

I tryed NDoc but it bugged using my XML files....
and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
no luck ;-(

any tips ? ideas ? or links ?

(yeah, I know, I could do it myself, but you know always the same problem
that the not quite finished project should be delivered yesterday :-)

Reply to this Message

Sreejumon[MVP] - 25 Jul 2003 06:01 GMT

Hi Lloyd,

Are you looking for a documentation of your code similar to MSDN help. I
mean class, members , properties like that. Using NDOC you can generate the
help file. Only thing is that you have to mention the entire comemnts to
your cod including ///summary, ///remarks etc. In NDOC there are some
options while generating the doc. So that you can hide the private members.

Let me know what is the error that you are getting from NDOC utility.

Regards
Sreejumon[MVP]
DOTNET makes IT happen

> I have generated my XML documentation.
> now what ?
[quoted text clipped - 8 lines]
> (yeah, I know, I could do it myself, but you know always the same problem
> that the not quite finished project should be delivered yesterday :-)

Reply to this Message

Lloyd Dupont - 28 Jul 2003 04:15 GMT

well when I said I had no luck with NDoc I mean I Had no luck with NDOC.
so I already tryed and was unsucessfull with it ....

> Hi Lloyd,
>
[quoted text clipped - 22 lines]
> > (yeah, I know, I could do it myself, but you know always the same problem
> > that the not quite finished project should be delivered yesterday :-)

Reply to this Message

Ron Bullman - 28 Jul 2003 15:58 GMT

Lloyd,
I would say that NDoc is best available tool for documenting. I have been
using it now almost one year.

Sreejumon,
Nice tool, however it can't handle properly methods whos names differs only
by case.

Ron

> well when I said I had no luck with NDoc I mean I Had no luck with NDOC.
> so I already tryed and was unsucessfull with it ....
[quoted text clipped - 28 lines]
> problem
> > > that the not quite finished project should be delivered yesterday :-)

Reply to this Message

XML documentation

Free Magazines