XML documentation - C# / C Sharp

Lloyd Dupont

I have generated my XML documentation.
now what ?
because the XML file is not quite human friendly....

I tryed NDoc but it bugged using my XML files....
and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
no luck ;-(

any tips ? ideas ? or links ?

(yeah, I know, I could do it myself, but you know always the same problem
that the not quite finished project should be delivered yesterday :-)

Nov 15 '05 #1

Subscribe Reply

3092

Sreejumon[MVP]

Hi Lloyd,

Are you looking for a documentation of your code similar to MSDN help. I
mean class, members , properties like that. Using NDOC you can generate the
help file. Only thing is that you have to mention the entire comemnts to
your cod including ///summary, ///remarks etc. In NDOC there are some
options while generating the doc. So that you can hide the private members.

Let me know what is the error that you are getting from NDOC utility.

Regards
Sreejumon[MVP]
DOTNET makes IT happen

"Lloyd Dupont" <ll***@galador.net> wrote in message
news:OV*************@TK2MSFTNGP09.phx.gbl...

I have generated my XML documentation.
now what ?
because the XML file is not quite human friendly....

I tryed NDoc but it bugged using my XML files....
and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
no luck ;-(

any tips ? ideas ? or links ?

(yeah, I know, I could do it myself, but you know always the same problem
that the not quite finished project should be delivered yesterday :-)

Nov 15 '05 #2

Lloyd Dupont

well when I said I had no luck with NDoc I mean I Had no luck with NDOC.
so I already tryed and was unsucessfull with it ....
"Sreejumon[MVP]" <sr********@hotmail.com> wrote in message
news:eS****************@TK2MSFTNGP12.phx.gbl...

Hi Lloyd,

Are you looking for a documentation of your code similar to MSDN help. I
mean class, members , properties like that. Using NDOC you can generate the help file. Only thing is that you have to mention the entire comemnts to
your cod including ///summary, ///remarks etc. In NDOC there are some
options while generating the doc. So that you can hide the private members.
Let me know what is the error that you are getting from NDOC utility.

Regards
Sreejumon[MVP]
DOTNET makes IT happen

"Lloyd Dupont" <ll***@galador.net> wrote in message
news:OV*************@TK2MSFTNGP09.phx.gbl...
I have generated my XML documentation.
now what ?
because the XML file is not quite human friendly....

I tryed NDoc but it bugged using my XML files....
and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
no luck ;-(

any tips ? ideas ? or links ?

(yeah, I know, I could do it myself, but you know always the same problem that the not quite finished project should be delivered yesterday :-)

Nov 15 '05 #3

Ron Bullman

Lloyd,
I would say that NDoc is best available tool for documenting. I have been
using it now almost one year.

Sreejumon,
Nice tool, however it can't handle properly methods whos names differs only
by case.
Ron
"Lloyd Dupont" <ll***@galador.net> wrote in message
news:#T*************@tk2msftngp13.phx.gbl...

well when I said I had no luck with NDoc I mean I Had no luck with NDOC.
so I already tryed and was unsucessfull with it ....
"Sreejumon[MVP]" <sr********@hotmail.com> wrote in message
news:eS****************@TK2MSFTNGP12.phx.gbl...
Hi Lloyd,

Are you looking for a documentation of your code similar to MSDN help. I
mean class, members , properties like that. Using NDOC you can generate

the
help file. Only thing is that you have to mention the entire comemnts to
your cod including ///summary, ///remarks etc. In NDOC there are some
options while generating the doc. So that you can hide the private

members.

Let me know what is the error that you are getting from NDOC utility.

Regards
Sreejumon[MVP]
DOTNET makes IT happen

"Lloyd Dupont" <ll***@galador.net> wrote in message
news:OV*************@TK2MSFTNGP09.phx.gbl...
I have generated my XML documentation.
now what ?
because the XML file is not quite human friendly....

I tryed NDoc but it bugged using my XML files....
and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
no luck ;-(

any tips ? ideas ? or links ?

(yeah, I know, I could do it myself, but you know always the same problem that the not quite finished project should be delivered yesterday :-)

Nov 15 '05 #4

Zhanyong Wan [MSFT]

Hi Lloyd,

Have you tried the following?

In the Visual Studio IDE, go to "Tools | Build Comment Web Pages...". It
will create HTML documentation for you.

--------------------
| From: "Lloyd Dupont" <ll***@galador.net>
| Subject: XML documentation
| Date: Fri, 25 Jul 2003 08:57:42 +1000
|
| I have generated my XML documentation.
| now what ?
| because the XML file is not quite human friendly....
|
| I tryed NDoc but it bugged using my XML files....
| and I also tryed to look for 'XML translator (C#)' on MSDN & Google..
| no luck ;-(
|
| any tips ? ideas ? or links ?
|
| (yeah, I know, I could do it myself, but you know always the same problem
| that the not quite finished project should be delivered yesterday :-)

- Zhanyong Wan

Visual Studio and .NET Setup

This posting is provided "AS IS" with no warranties, and confers no rights.
Use of included samples (if any) is subject to the terms specified at
http://www.microsoft.com/info/cpyright.htm

Nov 15 '05 #5

Similar topics

3244

Python Documentation?

by: Daniel R. Smorey Jr. | last post by:

I'm looking for a good place for Python documentation. I'm really lost on why it's so hard to find anything when it comes to me looking up a particular function in Python. My example would be the split() function of the string module. Why can't I just go to www.python.org and click on Search and then type in split and it bring me to the...

Python

1948

Proposal: an unchanging URL for Python documentation

by: Steve | last post by:

posted on: comp.lang.python emailed to: docs@python.org I have a suggestion/request that will, I think, improve the Python documentation. Currently, the Python documentation in HTML format is stored at URLs that change with each new release of Python. That is, for example, the documentation for the os module is at...

Python

2186

Python Documentation (should be better?)

by: Christopher J. Bottaro | last post by:

This post is just the culmination of my thoughts and discussions with my coworkers on Python. If you are not interested, please skip over it. At my work, we are developing a product from scratch. It is completely modular and the modules communicate via SOAP. Because of that, we can implement individual modules in any language of our...

Python

2135

design and architecture documentation

by: Jeff Levinson [mcsd] | last post by:

I'm an architect for a very large fortune 100 company and we still struggle with the best balance. However, I use a couple of simple guidelines that have worked very well for me in almost all cases (there have been some times when I've lived to regret some decisions). Use case work flows are the bread and butter of the documentation and...

.NET Framework

2392

XMLSpy - how to Generate Documentation for included files in schema

by: Almoni | last post by:

Hi, I have a few .xsd files that include each other in the following way:  <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

.NET Framework

2959

MSDN like documentation for Xml-files?

by: Ole Hanson | last post by:

I would like to be able to generate documentation for a custom configuration file (xml) to enable future support engineers to understand applicable values to the various elements inside the configuration file. (see below for sample). Does any program exist (like NDoc) that is able to generate MSDN like documentation?

.NET Framework

4286

Dr. Dobb's Python-URL! - weekly Python news and links (Dec 2)

by: Cameron Laird | last post by:

QOTW: "Python makes it easy to implement algorithms." - casevh "Most of the discussion of immutables here seems to be caused by newcomers wanting to copy an idiom from another language which doesn't have immutable variables. Their real problem is usually with binding, not immutability." - Mike Meyer Among the treasures available in The...

Python

1807

Automated documentation for .NET Framework 2.0 and Visual Studio 2005

by: innovasys | last post by:

TORQUAY, DEVON, UK - Innovasys announced the release of Document! X 5, the fifth version of the documentation solution of choice for developers using Microsoft Visual Studio or the .NET Framework. Document! X 5 automatically produces professional quality technical documentation and on-line help for Microsoft .NET Framework assemblies (.NET...

.NET Framework

2878

Pythondocs.info : collaborative Python documentation project

by: nicolasfr | last post by:

Hi, I am a bit disapointed with the current Python online documentation. I have read many messages of people complaining about the documentation, it's lack of examples and the use of complicated sentences that you need to read 10 times before understanding what it means. That's why I have started a collaborative project to make a user...

Python

7178

Changing the language in Windows 10

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 effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language...

Windows Server

7397

Problem With Comparison Operator <=> in G++

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, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. ...

C / C++

7563

Maximizing Business Potential: The Nexus of Website Design and Digital Marketing

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 tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that...

Online Marketing

7125

The easy way to turn off automatic updates for Windows 10/11

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 Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For...

Windows Server

7543

Discussion: How does Zigbee compare with other wireless protocols in smart home applications?

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 protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the...

General

4757

Couldn’t get equations in html when convert word .docx file to html file in C#.

by: conductexam | last post by:

I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert...

C# / C Sharp

3252

Trying to create a lan-to-lan vpn between two differents networks

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 last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in...

Networking - Hardware / Configuration

813

How to add payments to a PHP MySQL app.

by: muto222 | last post by:

How can i add a mobile payment intergratation into php mysql website.

PHP

470

Comprehensive Guide to Website Development in Toronto: Expert Insights from BSMN Consultancy

by: bsmnconsultancy | last post by:

In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating...

General