Code documentation.

[Fredrik Olsson]

Hello.

For Java there is javadac, for Obj-C headerdoc2html, for C doxygen, and even
for good old VB 6 there is VBDox.

But I have found no suitable tool for documenting my .net code to get
documentation that is consistent with what MSDN offers and .net-develoepers
are used to.

I guess I have only searched int he wrong places, or with the wrong keywords
:).

Any halpt is apreciated.

regards
//Fredrik Olsson

[Jon Skeet [C# MVP]]

Fredrik Olsson <Fr***********@ discussions.mic rosoft.com> wrote:

Lets See:
/// @param foo amount of bars.
And
/// <param name="foo">amou nt of bars</param>

Not close if you ask me
Agreed, but I suspect the other way round... I think the latter makes
it *far* clearer that the name of the parameter is "foo". I come from a
Java background, but I still far prefer the C# way of doing things when
it comes to documentation.
So I can not really see why the c# compiler can not do it.

They could certainly have defined C# to have JavaDoc syntax, but they
decided not to, presumably preferring the XML form - as I do.

--
Jon Skeet - <sk***@pobox.co m>
http://www.pobox.com/~skeet
If replying to the group, please do not mail me too

[Cool Guy]

Fredrik Olsson <Fr***********@ discussions.mic rosoft.com> wrote:

@[what it is] [what it is called] [what it does]
Clear and simple.

<[what it is] [tag depending on what it is]="[what it is called]">what it
does</[what it is again]>
Easier for an xml-parser yes, for a human to read and write? NO!

I agree. And XML documentation gets even more unreadable when things like
hyperlinks and HTML new line tags are include.

[Arnaud Debaene]

Fredrik Olsson wrote:

Yes it works, and it is what I use to genereate the documenattion for
the
COM-component to use in old Visual Basic 6, VBScript and addins for
Office.
But I am afraid it just works, it does not generate documentation
with the
look and feel of modern .net documentation as provided by Micrsooft
with more
modern Visual Studio. It just looks very unprofessional if the
documentation
is not on par with todays standrds.

It's NDoc that will the generate the doc with the "Look&Feel" you want!

Arnaud
MVP - VC