473,473 Members | 1,484 Online
Bytes | Software Development & Data Engineering Community
Create Post

Home Posts Topics Members FAQ

2.0: generating documentation for ///

Hello,
I am learning .NET 2.0. I need to learn how to create documentation
from /// comments. I downloaded sample project XMLsample from Web and
I generated XML documentation XMLsample.xml:

<?xml version="1.0"?>
<doc>
<assembly>
<name>XMLdoc</name>
</assembly>
<members>
<member name="T:SomeClass">
<summary>
Class level summary documentation goes here.</summary>
<remarks>
Longer comments can be associated with a type or member
through the remarks tag</remarks>
</member>
<member name="F:SomeClass.myName">
<summary>
Store for the name property</summary>
</member>
<member name="M:SomeClass.SomeMethod(System.String)">
<summary>
Description for SomeMethod.</summary>
<param name="s"> Parameter description for s goes
here</param>
<seealso cref="T:System.String">
You can use the cref attribute on any tag to reference a
type or member
and the compiler will check that the reference exists.
</seealso>
</member>
...
</members>
</doc>

I would like to have HTML file.
One way I see is to use XSL transform but I don't know XSLT yet. Can I
have XSLT (and so HTML) automatically?
Are there other solutions?

Thank you very much for your answers.
/RAM/
May 25 '06 #1
2 1229
Take a look at the open source NDoc tool which can convert the .xml files to
a number of formats including HTML help files:

http://ndoc.sourceforge.net/

======================
Clive Dixon
Digita Ltd. (www.digita.com)
"R.A.M." <r_********@poczta.onet.pl> wrote in message
news:u4********************************@4ax.com...
Hello,
I am learning .NET 2.0. I need to learn how to create documentation
from /// comments. I downloaded sample project XMLsample from Web and
I generated XML documentation XMLsample.xml:

<?xml version="1.0"?>
<doc>
<assembly>
<name>XMLdoc</name>
</assembly>
<members>
<member name="T:SomeClass">
<summary>
Class level summary documentation goes here.</summary>
<remarks>
Longer comments can be associated with a type or member
through the remarks tag</remarks>
</member>
<member name="F:SomeClass.myName">
<summary>
Store for the name property</summary>
</member>
<member name="M:SomeClass.SomeMethod(System.String)">
<summary>
Description for SomeMethod.</summary>
<param name="s"> Parameter description for s goes
here</param>
<seealso cref="T:System.String">
You can use the cref attribute on any tag to reference a
type or member
and the compiler will check that the reference exists.
</seealso>
</member>
...
</members>
</doc>

I would like to have HTML file.
One way I see is to use XSL transform but I don't know XSLT yet. Can I
have XSLT (and so HTML) automatically?
Are there other solutions?

Thank you very much for your answers.
/RAM/

May 25 '06 #2
Its my underatanding NDoc does not function with ASP.NET 2.0. The developer
was hired by Microsoft and their "policy" forbids further development. As
you can see from the notes on SourceForge it appears nothing has been added
since Feb 2005 over a year ago.
<%= Clinton Gallagher
NET csgallagher AT metromilwaukee.com
URL http://www.metromilwaukee.com/clintongallagher/

"Clive Dixon" <cl*******************@digita.noluncheonmeat.com > wrote in
message news:%2***************@TK2MSFTNGP02.phx.gbl...
Take a look at the open source NDoc tool which can convert the .xml files
to a number of formats including HTML help files:

http://ndoc.sourceforge.net/

======================
Clive Dixon
Digita Ltd. (www.digita.com)
"R.A.M." <r_********@poczta.onet.pl> wrote in message
news:u4********************************@4ax.com...
Hello,
I am learning .NET 2.0. I need to learn how to create documentation
from /// comments. I downloaded sample project XMLsample from Web and
I generated XML documentation XMLsample.xml:

<?xml version="1.0"?>
<doc>
<assembly>
<name>XMLdoc</name>
</assembly>
<members>
<member name="T:SomeClass">
<summary>
Class level summary documentation goes here.</summary>
<remarks>
Longer comments can be associated with a type or member
through the remarks tag</remarks>
</member>
<member name="F:SomeClass.myName">
<summary>
Store for the name property</summary>
</member>
<member name="M:SomeClass.SomeMethod(System.String)">
<summary>
Description for SomeMethod.</summary>
<param name="s"> Parameter description for s goes
here</param>
<seealso cref="T:System.String">
You can use the cref attribute on any tag to reference a
type or member
and the compiler will check that the reference exists.
</seealso>
</member>
...
</members>
</doc>

I would like to have HTML file.
One way I see is to use XSL transform but I don't know XSLT yet. Can I
have XSLT (and so HTML) automatically?
Are there other solutions?

Thank you very much for your answers.
/RAM/


May 28 '06 #3

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

3
by: paul brown | last post by:
I've been looking up the in the documentation, but I can't seem to find what I'm looking for. I want to do query a MySQL table and return the results to the browser as an XML doc. What's the...
8
by: Tim Daneliuk | last post by:
I use a makefile to create distribution tarballs of freestanding Python programs and their documentation. I cannot seem to find the right command line option to just generate a pyc/pyo file from...
5
by: daniele.balducci | last post by:
Hi All, I'm generating XLS files from ASP(.Net) code using the usual code chunks ... Response.ContentType = "application/vnd.ms-excel" Response.AppendHeader("Content-Disposition", "attachment;...
4
by: Bill J | last post by:
Hi Everyone, Is there a way of generating a keyboard character event and sending it to a control on a form? For example, if I have a menu item called "Delete", I would like to send a DEL...
1
by: Ryan Ginstrom | last post by:
I have been maintaining a body of documentation in plain HTML files. I would now like to automate the generation of the HTML files. Maintaining the HTML files now is tedious and error prone,...
0
by: Let_Me_Be | last post by:
Hi, helping our C/C++ teacher and would like to modify the curent website of this two classes. What I would like to include is doxygen generated documentation for stl classes (and link it with...
3
by: Noman Ali | last post by:
Hi, It seems that ASP .NET 2.0 does not support XML documentation feature. Is there any way to do this? I serached alot and only find this solution but it didnot works for C#. Here it is. ...
1
by: ganesh22 | last post by:
Hi.. We did a project on ASP.NET using C# ,Now I want to write documentation on the project so is there any one for generating Documentation!! Can U help!
0
by: silpa | last post by:
Hi, For Generating Website for API documentation using Sandcastle I opened Powershell window and gave the command scbuild –framework 2.0 –sources Class1.dll,comments.xml –BuildWebsite ...
0
marktang
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,...
0
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
1
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
0
tracyyun
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...
0
agi2029
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,...
0
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The...
0
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
0
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated ...
0
muto222
php
by: muto222 | last post by:
How can i add a mobile payment intergratation into php mysql website.

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.