?
=?ISO-8859-1?Q?Lasse_V=E5gs=E6ther_Karlsen?=
I've been using XML Documentation in my class libraries since I
discovered this, and I have been using NDoc to produce help files from
the xml files so that the documentation is available outside of Visual
Studio as well.
With the introduction of .NET 2.0, generics, iterators, etc. NDoc seems
to be behind in support for this. I've looked at the code but unless
you're one of the main contributors I think it's going to be hard to
just retrofit support for that into it without spending a lot of time
with it. It also sounds like, from their webpage, NDoc is going to get
this support but it seems last update was in february...
So, are there any alternatives ? Basically I need the ability to produce
Html Help or similar from the xml documentation. Rewriting the xml
documentation to fit the style of a different tool is doable, as long as
the help is still available in code intellisense. In other words,
switching to javadoc syntax is not an option.
I've been trying the following tools:
Doc-O-Matic professional 4:
- really not fit for production yet. Does not handle links to runtime
types all that well, test-projects I made only managed to document that
I *had* files in the project, the classes in them was not part of the
output at all, confusing layout, seems to not understand all the xml
tags and all the ways to use them (<see cref="..."/> is ok, <see
cref="...">...</see> is not).
DocumentX:
- not updated for 2.0, outputs Collection`1 for generic types, relocates
all information regarding the <T> types to the remarks section,
relocates a lot of information to the remarks section really whereas a
lot of remarks is just lost, tends to get example documentation wrong
(bulks up the titles of the examples before all the examples)
Are there any other alternatives, save doing it manually which is not an
option?
discovered this, and I have been using NDoc to produce help files from
the xml files so that the documentation is available outside of Visual
Studio as well.
With the introduction of .NET 2.0, generics, iterators, etc. NDoc seems
to be behind in support for this. I've looked at the code but unless
you're one of the main contributors I think it's going to be hard to
just retrofit support for that into it without spending a lot of time
with it. It also sounds like, from their webpage, NDoc is going to get
this support but it seems last update was in february...
So, are there any alternatives ? Basically I need the ability to produce
Html Help or similar from the xml documentation. Rewriting the xml
documentation to fit the style of a different tool is doable, as long as
the help is still available in code intellisense. In other words,
switching to javadoc syntax is not an option.
I've been trying the following tools:
Doc-O-Matic professional 4:
- really not fit for production yet. Does not handle links to runtime
types all that well, test-projects I made only managed to document that
I *had* files in the project, the classes in them was not part of the
output at all, confusing layout, seems to not understand all the xml
tags and all the ways to use them (<see cref="..."/> is ok, <see
cref="...">...</see> is not).
DocumentX:
- not updated for 2.0, outputs Collection`1 for generic types, relocates
all information regarding the <T> types to the remarks section,
relocates a lot of information to the remarks section really whereas a
lot of remarks is just lost, tends to get example documentation wrong
(bulks up the titles of the examples before all the examples)
Are there any other alternatives, save doing it manually which is not an
option?