Archive | Articles RSS feed for this section

Documenting VB.NET Source Code with XML Comments

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 […]

Read more
Figure 2. Adding a table column description via SQL Server 2008's SQL Server Management Studio

Documenting Microsoft SQL Server 2005/2008 Databases

This article describes how the improvements in Microsoft’s SQL Server 2005 or 2008 relational database allow for most database entities to be documented. The documentation is held within the database itself, allowing the documentation to be kept synchronised with the database itself. These enhancements offer the possibility of a self-documenting database, saving many hours of […]

Read more
Figure 1. Adding a table column description via the SQL Server Enterprise Manager

Documenting a Microsoft SQL Server Database

This article describes how to document your Microsoft SQL Server database. The principles are similar for all versions of SQL Server, although SQL Server 2005 and above contain a number of neat enhancements to database documentation capabilities. The article includes database naming conventions, adding object descriptions, documenting stored procedures, and how to create technical documentation […]

Read more
HTML Help source code documentation produced by the ASP Documentation Tool

Writing Software Documentation

This article describes what documentation you should consider writing for your software products, and how to go about producing the different types of documentation. Documentation for Installation (ReadMe’s) Most software is supplied with a text or HTML based file that explains how to install the software. Typically the file is called something readme.txt or ReadMeFirst.html. […]

Read more

Code Reviewing ASP Source Code

Code reviews are the process of examining an application’s source code in order to find coding errors and identify regions of code that could be improved. These reviews can often improve application reliability and efficiency. As well as assisting with the creation of technical documentation, our ASP Documentation Tool can assist with code reviews of […]

Read more

NDoc Alternative – the .NET Documentation Tool

NDoc was a popular utility for documenting .NET Framework source code. Unfortunately, the latest version of NDoc, 1.3.1, was released way back in 2005 and only has very limited support for version 2.0 or above of the .NET Framework. The main developer on the NDoc project has indicated that he will no longer be updating […]

Read more