Software Documentation.Info Logo
  home | technical writing | business software | software documentation tools | service business software | software testing | contact
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).


SEARCH WEBSITE
 Search Website

CATEGORIES
Articles / Whitepapers
Technical Writing
  Technical Writers/Authors
  Technical Writing Services Software Documentation Tools
  Source Code Documentation Tools
    ASP
    .NET Framework
    Visual Basic
    SQL Server
    MySQL
    C++
    Java
    PHP
  End User Documentation Tools
  Business Software
    Document Tracking Software
    Relational Databases
    Monitoring Software
    Service Business Software
    Testing Tools
  ASP.NET Training Courses

WHAT'S NEW?
Starting Your Own Software Company
Toad for SQL Server
SQL Developer Tool
Software Documentation Articles
Aperture Card Scanning
Barcode Document Tracking Software
Service Business Software
More New Stuff...

OTHER SITES
Accounting & Tax Services
Business Management Software
Documentation Generators

CODE DOCUMENTORS
ASP Documentation Tool
.NET Documentation Tool
SQL Documentation Tool
VB Documentation Tool
PHP Documentation Tool

© 2007 - 2011 Winnersh Triangle Web Solutions Limited. Registered company number: 4493816.
Page created Monday, September 17, 2007. Last modified Monday, September 17, 2007.
About SoftwareDocumentation.info | Site Map | Privacy Policy | Add Your Site
Subscribe to our blog and be notified about new software documentation resources