Software Documentation.Info Logo

 
Subscribe to our blog and be notified about new business software resources
  home | technical writing | business software | software documentation tools | service business software | software testing | contact

Other Software Links

Home > Software Documentation Articles > Documenting C# source code

Documenting C# source code

What are code documentation standards?

Many programming languages have well defined standards for documenting source code. These standards are useful in that they allow developers to add comments to code in a uniform format. Furthermore, it is possible to use tools to extract the documentation from an entire application's source code and use it to automatically produce project technical documentation in a fraction of the time it would take to manually produce the documentation.

Programming languages such as Java have had code documentation standards for many years. The Java system is called JavaDoc, and allows developers to easily create HTML format documentation from project source code.

With the introduction of the .NET Framework and the new C# programming language, Microsoft included some form of code documentation standards - XML Comments. These were further enhanced with the 2.0 release of the .NET Framework (which also allowed XML comments to be used with VB.NET...

Read the full article at http://www.winnershtriangle.com/w/Articles.XMLCommentsInCSharp.asp.

The .NET Documentation Tool automatically creates comprehensive technical documentation from C# source code (VB.NET is also supported).

Related content: documenting, source code, csharp, comments, documentation, coding standards


© 2007 - 2012 Winnersh Triangle Web Solutions Limited.
Registered company number: 4493816.

Page created Monday, September 17, 2007. Last modified Monday, September 17, 2007.
About This Website | | Site Map | Privacy Policy | Add Your Site