473,379 Members | 1,379 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,379 software developers and data experts.

How to document the code?

HEllo everybody, I have to realize the documentation for my software
and I would like to create a doc or rtf file. However I'm using the
software ndoc that seems very useful for chm files, but there is not
way to export the documentation in word format. Is there some other
tool? for C I used doxygen that worked very well, but it doesn't
support very well C#....
please hel.
Thanks

--
My Email is correct

Inviato da www.mynewsgate.net
Nov 16 '05 #1
3 1009
Giox,

I would use the XML commenting, and generate the XML documentation. You
can add any XML tags you want. Once you have that, you can create word
documents from the XML (the latest version of word supports XML, and you can
actually create a template in word that will take XML docs fitting the
schema and have it perform layout and whatnot).

Hope this helps.
--
- Nicholas Paldino [.NET/C# MVP]
- mv*@spam.guard.caspershouse.com

"Giox" <gi*************@yahoo.it> wrote in message
news:20****************@mynewsgate.net...
HEllo everybody, I have to realize the documentation for my software
and I would like to create a doc or rtf file. However I'm using the
software ndoc that seems very useful for chm files, but there is not
way to export the documentation in word format. Is there some other
tool? for C I used doxygen that worked very well, but it doesn't
support very well C#....
please hel.
Thanks

--
My Email is correct

Inviato da www.mynewsgate.net

Nov 16 '05 #2
Well ... I don't know of any tool that outputs .doc format, but you
could always output as HTML instead of chm from ndoc.

Joel Martinez
http://www.onetug.org - Orlando .NET User Group
http://www.codecube.net - blog

"Giox" <gi*************@yahoo.it> wrote in message news:<20****************@mynewsgate.net>...
HEllo everybody, I have to realize the documentation for my software
and I would like to create a doc or rtf file. However I'm using the
software ndoc that seems very useful for chm files, but there is not
way to export the documentation in word format. Is there some other
tool? for C I used doxygen that worked very well, but it doesn't
support very well C#....
please hel.
Thanks

Nov 16 '05 #3
Thanks for your help,but I have Office XP, is tehere something similar
to office 2003 ?
Thanks again Giovanni

Nicholas Paldino [.NET/C# MVP] <mv*@spam.guard.caspershouse.com> ha
scritto:
Giox,

I would use the XML commenting, and generate the XML documentation. You can add any XML tags you want. Once you have that, you can create word documents from the XML (the latest version of word supports XML, and you can actually create a template in word that will take XML docs fitting the
schema and have it perform layout and whatnot).

Hope this helps.

--
My Email is correct

Inviato da www.mynewsgate.net
Nov 16 '05 #4

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

Similar topics

1
by: techy techno | last post by:
Hii Just wanted to know how can I decorate my texboxes and Listmenu which is called from a JS file using the following code below: document.write("<SELECT NAME='cur2' ONCHANGE='cconv1();'>");...
6
by: David List | last post by:
I'm having a problem using different properties of the document object in the example javascripts in my textbook with browsers that identify themselves as using the Mozilla engine. One example of...
2
by: Brett Baisley | last post by:
Hello I have a block of html code that I want to run by calling a javascript function to print it. Its basically a table with menu items in it that is the same for many pages, and instead of...
12
by: Kepler | last post by:
How do you get the height of the client browser in IE? Both document.body.clientHeight and document.body.offsetHeight return the height of the document. If the page is long and there's a vertical...
13
by: Stumped and Confused | last post by:
Hello, I really, really, need some help here - I've spent hours trying to find a solution. In a nutshell, I'm trying to have a user input a value in form's textfield. The value should then be...
8
by: Phil Powell | last post by:
if (document.location.href.indexOf('?') >= 0) document.location.href = document.location.href.substring(0, document.location.href.indexOf('?')); if (document.location.href.indexOf('#') >= 0) {...
136
by: Matt Kruse | last post by:
http://www.JavascriptToolbox.com/bestpractices/ I started writing this up as a guide for some people who were looking for general tips on how to do things the 'right way' with Javascript. Their...
3
by: Andy Davis | last post by:
I have set up a mail merge document in Word 2003 which gets its data from my Access 2000 database. I want to set up a button on a form that: 1. runs the query to provide the dat for the merge...
2
by: kigoobe | last post by:
Well, I'm getting an error. Here is the function, what, according to FF's consolde is generating the error. function citizen3() { if (document.ededfil.nationalite.checked == true) { ...
4
by: dr1ft3r | last post by:
Hey guys, I'm building a site for a landscaping business down the street and can't seem to get part of the code functioning correctly. The code fails on line 68 where I make a reference to an...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
0
by: Faith0G | last post by:
I am starting a new it consulting business and it's been a while since I setup a new website. Is wordpress still the best web based software for hosting a 5 page website? The webpages will be...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...
0
by: taylorcarr | last post by:
A Canon printer is a smart device known for being advanced, efficient, and reliable. It is designed for home, office, and hybrid workspace use and can also be used for a variety of purposes. However,...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: aa123db | last post by:
Variable and constants Use var or let for variables and const fror constants. Var foo ='bar'; Let foo ='bar';const baz ='bar'; Functions function $name$ ($parameters$) { } ...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...

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.