473,326 Members | 2,102 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,326 software developers and data experts.

Documentation

i work with c# windows application, and i want to know how to do
documentation? if i use UML or Flowchart or DFD ? if exists some site
or book or same example to help.

Thanks

*** Sent via Developersdex http://www.developersdex.com ***
Nov 17 '05 #1
3 1379
Your best bet is to use the inluine XML documentation that is added by the
IDE for classes, structures, properties and methods when you use the "///"
prefix in your code.

This generates XML which can then be formatted by other programs into class
documentation. I highly recommend NDoc which can be obtained free from
SourceForge.

--
Bob Powell [MVP]
Visual C#, System.Drawing

Ramuseco Limited .NET consulting
http://www.ramuseco.com

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.

"junior lopes" <ho******@hotmail.com> wrote in message
news:%2******************@TK2MSFTNGP14.phx.gbl...
i work with c# windows application, and i want to know how to do
documentation? if i use UML or Flowchart or DFD ? if exists some site
or book or same example to help.

Thanks

*** Sent via Developersdex http://www.developersdex.com ***

Nov 17 '05 #2
/doc will document the interfaces, but not the internal logic. Junior's
question is more generalized than just wanting interface documentation.

UML does provide a subset of the ways of documenting processes and systems.
The goals of UML as well as the use of each modeling tool are published at
the following location:
http://www.uml.org

You need to evaluate the cost/benefit of your documentation effort. The
process that we use are like the systems that we develop, get your
requirements before trying to implement a solution.

Bob's answer may be right on the money if you are just trying to know why
you coded the method at all and why it is coded that way.

"Bob Powell [MVP]" wrote:
Your best bet is to use the inluine XML documentation that is added by the
IDE for classes, structures, properties and methods when you use the "///"
prefix in your code.

This generates XML which can then be formatted by other programs into class
documentation. I highly recommend NDoc which can be obtained free from
SourceForge.

--
Bob Powell [MVP]
Visual C#, System.Drawing

Ramuseco Limited .NET consulting
http://www.ramuseco.com

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.

"junior lopes" <ho******@hotmail.com> wrote in message
news:%2******************@TK2MSFTNGP14.phx.gbl...
i work with c# windows application, and i want to know how to do
documentation? if i use UML or Flowchart or DFD ? if exists some site
or book or same example to help.

Thanks

*** Sent via Developersdex http://www.developersdex.com ***


Nov 17 '05 #3
/doc will document the interfaces, but not the internal logic. Junior's
question is more generalized than just wanting interface documentation.

UML does provide a subset of the ways of documenting processes and systems.
The goals of UML as well as the use of each modeling tool are published at
the following location:
http://www.uml.org

You need to evaluate the cost/benefit of your documentation effort. The
process that we use are like the systems that we develop, get your
requirements before trying to implement a solution.

Bob's answer may be right on the money if you are just trying to know why
you coded the method at all and why it is coded that way.

"Bob Powell [MVP]" wrote:
Your best bet is to use the inluine XML documentation that is added by the
IDE for classes, structures, properties and methods when you use the "///"
prefix in your code.

This generates XML which can then be formatted by other programs into class
documentation. I highly recommend NDoc which can be obtained free from
SourceForge.

--
Bob Powell [MVP]
Visual C#, System.Drawing

Ramuseco Limited .NET consulting
http://www.ramuseco.com

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.

"junior lopes" <ho******@hotmail.com> wrote in message
news:%2******************@TK2MSFTNGP14.phx.gbl...
i work with c# windows application, and i want to know how to do
documentation? if i use UML or Flowchart or DFD ? if exists some site
or book or same example to help.

Thanks

*** Sent via Developersdex http://www.developersdex.com ***


Nov 17 '05 #4

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

Similar topics

20
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...
11
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...
24
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...
0
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...
0
by: Almoni | last post by:
Hi, I have a few .xsd files that include each other in the following way: <!-- lets call the main schema file AA.xsd and it includes BB.xsd inside it --> <xs:schema...
1
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...
97
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...
0
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....
34
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...
0
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: jfyes | last post by:
As a hardware engineer, after seeing that CEIWEI recently released a new tool for Modbus RTU Over TCP/UDP filtering and monitoring, I actively went to its official website to take a look. It turned...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: PapaRatzi | last post by:
Hello, I am teaching myself MS Access forms design and Visual Basic. I've created a table to capture a list of Top 30 singles and forms to capture new entries. The final step is a form (unbound)...
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...
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
by: af34tf | last post by:
Hi Guys, I have a domain whose name is BytesLimited.com, and I want to sell it. Does anyone know about platforms that allow me to list my domain in auction for free. Thank you
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...

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.