|
ASP Kitchen: Classic ASP Articles: NDoc: documentor tool for .NET Framework applications
NDoc: documentor tool for .NET Framework applications
NDoc is a
popular open source utility for documenting .NET Framework source code. Unfortunately, the latest
version, 1.3.1 was released way back in 2005, and only has very limited support for version 2.0 of
the .NET Framework. There is no support for version 3.0+ of the .NET Framework either. The main developer on the NDoc project has indicated that he will no longer
be updating NDoc.If you are looking for an alternative to NDoc then you may be interested in the
.NET Documentation Tool
product, which is able to automatically generate comprehensive technical documentation for any
type of .NET Framework project. Like NDoc, it is able to produce comprehensive,
cross-referenced and searchable documentation in a range of formats, including HTML Help
and RTF.
The .NET Documentation Tool offers other advantages over NDoc:
- Supports .NET Framework 1.0, 1.1 and 2.0. Both C# and VB.NET languages
are supported.
- Microsoft SQL Server and Access databases associated with projects can be documented.
- The .NET Documentation Tool can document .NET source code, no compilation of assemblies
is required.
- It has additional support for ASP.NET web applications: it supports code
behind files and extends documentation to the following: master pages (.master), user
controls (.ascx), web.config files, CSS, JavaScript files and web services (.asmx).
- Technical support is available.
If you like the signifiant time and money savings afforded by the use of
automatic code documentors, you may be interested in our other technical documentation
products:
- The ASP Documentation Tool documents
Active Server Pages (ASP) web applications, supporting both VBScript or JScript (with some
support for client-side JavaScript). Microsoft SQL Server and Access databases associated
with the web application can also be documented.
- The SQL Documentation Tool is a
standalone database documentor utility for Microsoft SQL Server 7.0, 2000 and 2005 databases.
Useful Development Tools
| ASP
Documentation Tool™ |
| Automatically creates technical documentation for ASP 2.0
and 3.0 web applications written in VBScript and JScript. Documentation for Microsoft
Access, SQL Server 7/2000 databases and Visual Basic 6.0 components associated with the
web application can also be incorporated into the reports. Documentation is created in
HTML, HTML Help and plain text formats. |
 View Sample
Output (HTML Help format).
 View Sample Output (HTML Format).
 Download
Trial Version (5.2Mb ZIP file). |
| .NET Documentation Tool |
| Automatically creates technical documentation for .NET Framework applications written in C# or VB.NET (including ASP.NET).
Documentation for SQL Server 7/2000/2005 databases and C#/VB.NET components associated with the
web application can also be incorporated into the reports. Documentation is created in
HTML, HTML Help and plain text formats. Additional support for ASP.NET web applications. A useful alternative to NDoc! |
View Sample
Output (HTML Help format).
View Sample Output (HTML Format).
Download
Trial Version (3Mb ZIP file). |
| SQL
Documentation Tool |
| The SQL Documentation Tool creates technical documentation for Microsoft SQL Server 7.0, 2000 and 2005 databases. Technical documentation is created in HTML and HTML Help formats. The HTML Help format documentation is fully searchable and cross referenced. The SQL Documentation Tool documents SQL Server Tables, Views, Stored Procedures, Triggers, Table Relationships, Jobs and DTS Packages. |
View Sample
Output (HTML Help format).
View Sample Output (HTML Format).
Download
Trial Version (10.3Mb ZIP file). |
| Text Workbench |
| Text Workbench is a file search and replacement utility for text files and Microsoft Office documents. Make rapid file replacements on multiple files and folders full of files. Advanced replacement options include regular expressions support. It even works on remote file systems via FTP. A Regular Expression Laboratory allows advanced pattern matching and replacement expressions to be built and tested. This great utility will make your everyday development tasks much easier!
|
|
Download
Trial Version (3Mb ZIP file; you have the option to either install directly from this link or save the file for later installation). |
| ASP Spell Check |
| ASPSpellCheck is the easy way to add spell checking capabilities to your ASP or ASP.NET websites, Intranets and web applications. The utility allows you to add spell checking capabilities to any HTML text field or rich content editing text box. It works with all common web browsers, and there are no components or databases to install on the server.
|
Read ASPSpellCheck Review.
View ASPSpellCheck Examples.
Download
Trial Version (3Mb ZIP file; you have the option to either install directly from this link or save the file for later installation). |
Author details
Brett Burridge
has worked as a web developer since 1997 and has developed web applications for a range of corporations, start up busiensses and educational establishments.
Brett is presently employed as an Internet developer and technical writer
through his own company,
Winnersh Triangle Web Solutions Limited.
The company produces a number of
innovative products, including a range of software documentation tools, which include the
ASP Documentation Tool™, the .NET Documentation Tool for VB.NET and C#, and the SQL Server Documentation Tool. Other products include The Website Utility, which functions as a website error checker, search engine optimizer and ASP/ASP.NET search engine builder application.
As well as the ASPAlliance, Brett has written articles for Ariadne.ac.uk,
ASPToday, the software documentation portal www.softwaredocumentation.info, and has contributed recipes to the ASP.NET Developer's Cookbook.
links
Outside web development, Brett is interested in travelling (here are my travel logs from New York, Hong Kong and Tokyo), digital photography (here's my photo gallery), tropical fishkeeping
and collecting contemporary works of art by artists such as Doug Hyde.
Contact Brett by emailing
Article history
"NDoc: documentor tool for .NET Framework applications" published on ASPAlliance.com on 20 December
2007, last revised 20 December 2007.
ASP Kitchen: Classic ASP Articles: NDoc: documentor tool for .NET Framework applications
|
|
