Documenting namespaces in C#

  • Thread starter Thread starter Thomas Koch
  • Start date Start date
T

Thomas Koch

Hi - does anyone know if it is possible to document namespaces in C# using
the XML documentation tags or something similar?

Cheers
Thomas Koch
 
Thomas,

I don't think this is possible yet. If you want to do it, then I think
that you will have to generate it yourself. However, it shouldn't be too
hard to create a template of some kind using Reflection to get the classes
in an assembly which fall in a namespace.

Hope this helps.
 
Hi - Nicholas,

I'd rather avoid that (I'm a lazy programmer ;-)

I am using NDoc to generate the packed HTML help document (.chm file) from
the XML documentation file created by the C# compiler, so I had hoped
something more toolable existed.

Do you know if its possible to insert/modify the HTML files into a .chm
file?

Thomas Koch


Nicholas Paldino said:
Thomas,

I don't think this is possible yet. If you want to do it, then I think
that you will have to generate it yourself. However, it shouldn't be too
hard to create a template of some kind using Reflection to get the classes
in an assembly which fall in a namespace.

Hope this helps.


--
- Nicholas Paldino [.NET/C# MVP]
- (e-mail address removed)

Thomas Koch said:
Hi - does anyone know if it is possible to document namespaces in C# using
the XML documentation tags or something similar?

Cheers
Thomas Koch
Click to expand...
Click to expand...
 
Have you seen the button "Namespace summaries" in the ndoc gui that let's
you add summaries for each namespace. At least in version 1.2 It's
probably the easiest way to add summaries. But it would be better to have
the summaries in files in your VS project / solution to make it easier to
edit from VS. Colin Young's post might be the way to go in that case.


--
Mike Mayer
http://www.mag37.com/csharp/
(e-mail address removed)


Thomas Koch said:
Hi - Nicholas,

I'd rather avoid that (I'm a lazy programmer ;-)

I am using NDoc to generate the packed HTML help document (.chm file) from
the XML documentation file created by the C# compiler, so I had hoped
something more toolable existed.

Do you know if its possible to insert/modify the HTML files into a .chm
file?

Thomas Koch


in message news:[email protected]...
Thomas,

I don't think this is possible yet. If you want to do it, then I think
that you will have to generate it yourself. However, it shouldn't be too
hard to create a template of some kind using Reflection to get the classes
in an assembly which fall in a namespace.

Hope this helps.


--
- Nicholas Paldino [.NET/C# MVP]
- (e-mail address removed)

Thomas Koch said:
Hi - does anyone know if it is possible to document namespaces in C# using
the XML documentation tags or something similar?

Cheers
Thomas Koch
Click to expand...
Click to expand...
Click to expand...
 
Hi Colin & Michael - thanks for the replies, they were just what I was
looking for. :-)

Colin - if you are using a separate xml file, what then is the format of the
namespace documentation here?

I can see that class entries in the xml file has this format:

<member name="T:MyNamespace.MyClass">
<summary>
.........
</summary>
</member>

But I cannot see what the format should be for at namespace.

Thomas
 
<namespaces>
<namespace name="REX.DAL">
documentation goes here...
</namespace>
</namespaces>

Colin
 
Back
Top