Hi - does anyone know if it is possible to document namespaces in C# using
the XML documentation tags or something similar?
Cheers
Thomas Koch
7  7249 
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]
- ni**************@exisconsulting.com
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Op**************@TK2MSFTNGP09.phx.gbl... Hi - does anyone know if it is possible to document namespaces in C# using
the XML documentation tags or something similar?
Cheers
Thomas Koch
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 [.NET/C# MVP]" <ni**************@exisconsulting.com> wrote
in message news:uT**************@TK2MSFTNGP12.phx.gbl... 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]
- ni**************@exisconsulting.com
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Op**************@TK2MSFTNGP09.phx.gbl... Hi - does anyone know if it is possible to document namespaces in C#
using the XML documentation tags or something similar?
Cheers
Thomas Koch
You can create a separate XML file with the namespace documentation in it,
and then include that file when you build the docs. I have mine in a file
called NamespaceSummary.xml and include that when I do my doc build (I use
NDoc from NAnt).
In NDoc you can also use a class called NamespaceDoc in each namespace to
provide documentation.
Colin
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Op**************@TK2MSFTNGP09.phx.gbl... Hi - does anyone know if it is possible to document namespaces in C# using
the XML documentation tags or something similar?
Cheers
Thomas Koch
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/ mi**@mag37.com
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:O$**************@TK2MSFTNGP11.phx.gbl... 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 [.NET/C# MVP]" <ni**************@exisconsulting.com>
wrote in message news:uT**************@TK2MSFTNGP12.phx.gbl... 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]
- ni**************@exisconsulting.com
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Op**************@TK2MSFTNGP09.phx.gbl... Hi - does anyone know if it is possible to document namespaces in C#
using the XML documentation tags or something similar?
Cheers
Thomas Koch
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
"Colin Young" <x@nospam.com> wrote in message
news:eB**************@TK2MSFTNGP12.phx.gbl... You can create a separate XML file with the namespace documentation in it,
and then include that file when you build the docs. I have mine in a file
called NamespaceSummary.xml and include that when I do my doc build (I use
NDoc from NAnt).
In NDoc you can also use a class called NamespaceDoc in each namespace to
provide documentation.
Colin
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Op**************@TK2MSFTNGP09.phx.gbl... Hi - does anyone know if it is possible to document namespaces in C#
using the XML documentation tags or something similar?
Cheers
Thomas Koch
<namespaces>
<namespace name="REX.DAL">
documentation goes here...
</namespace>
</namespaces>
Colin
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Og**************@TK2MSFTNGP12.phx.gbl... 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
"Colin Young" <x@nospam.com> wrote in message
news:eB**************@TK2MSFTNGP12.phx.gbl... You can create a separate XML file with the namespace documentation in
it, and then include that file when you build the docs. I have mine in a
file called NamespaceSummary.xml and include that when I do my doc build (I
use NDoc from NAnt).
In NDoc you can also use a class called NamespaceDoc in each namespace
to provide documentation.
Colin
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Op**************@TK2MSFTNGP09.phx.gbl... Hi - does anyone know if it is possible to document namespaces in C#
using the XML documentation tags or something similar?
Cheers
Thomas Koch
Ah - thanx!!
Thomas
"Colin Young" <x@nospam.com> wrote in message
news:OQ**************@TK2MSFTNGP11.phx.gbl... <namespaces>
<namespace name="REX.DAL">
documentation goes here...
</namespace>
</namespaces>
Colin
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Og**************@TK2MSFTNGP12.phx.gbl... 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
"Colin Young" <x@nospam.com> wrote in message
news:eB**************@TK2MSFTNGP12.phx.gbl... You can create a separate XML file with the namespace documentation in it, and then include that file when you build the docs. I have mine in a file called NamespaceSummary.xml and include that when I do my doc build (I use NDoc from NAnt).
In NDoc you can also use a class called NamespaceDoc in each namespace to provide documentation.
Colin
"Thomas Koch" <th********@yahoo.dk> wrote in message
news:Op**************@TK2MSFTNGP09.phx.gbl...
> Hi - does anyone know if it is possible to document namespaces in C#
using > the XML documentation tags or something similar?
>
> Cheers
> Thomas Koch
>
>
This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics
by: Frans Englich |
last post by:
Hello,
I have a custom module which among others contains a dictionary, acting as a
"constant". I want to document it, but no matter what I do, it doesn't show
up in `pydoc`. For example, the...
|
by: Steven Bethard |
last post by:
In the "empty classes as c structs?" thread, we've been talking in some
detail about my proposed "generic objects" PEP. Based on a number of
suggestions, I'm thinking more and more that instead of...
|
by: Isaac Rodriguez |
last post by:
Hi,
Are there any standarized ways of documenting Python code? When I check the
__doc__ attribute of the standard modules, the results are kind of plain. Is
everyone using this style?
Since...
|
by: Lasse Vågsæther Karlsen |
last post by:
I notice that if I use this syntax:
def classname:
...
##
# closes the database connection and releases the resources.
def close(self):
....
##
|
by: Jelmer |
last post by:
Hi,
I am mildly familiar with ms access developement and I have been asked to
port and document a ms access app. I expect the porting (97 to XP) to be
fairly straightforward. However documenting...
|
by: strauss.sean |
last post by:
I have been asked to begin documenting the ongoing development and
changes to a database that I maintain. Not the entry of data; this is
about the changes to how tables are restructured, and any...
|
by: Jeff Rodriguez |
last post by:
What sort of documentation do you do on your code? I've never done any code
development on a big project and I want to start documenting my code in a way
that makes sense, is easy to understand,...
|
by: Brett |
last post by:
I'd like to have all of my documentation in one place. I use the following
for documenting code:
- attributes for certain types of documentation
- use of the C# generated inline XML...
|
by: Spleenwort |
last post by:
With regard to XML comments in c#.
I think that #regions should be self-documenting relative to XML
comments or that a <region> tag should be defined and auto-inserted
when you type #region...
|
by: Charles Arthur |
last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
|
by: ryjfgjl |
last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
|
by: BarryA |
last post by:
What are the essential steps and strategies outlined in the Data Structures and Algorithms (DSA) roadmap for aspiring data scientists? How can individuals effectively utilize this roadmap to progress...
|
by: nemocccc |
last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
|
by: Oralloy |
last post by:
Hello folks,
I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>".
The problem is that using the GNU compilers,...
|
by: jinu1996 |
last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
|
by: tracyyun |
last post by:
Dear forum friends,
With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
|
by: agi2029 |
last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
| |
