c documentation tool 7.4
c documentation tool 7.4
The .NET Documentation Tool is a source code documentor that creates technical documentation for Windows .NET Framework 1.0, 1.1 and 2.0 projects written in C# (VB.NET is also supported). As such, it is the quickest and most cost effective way of automatically documenting and understanding Windows .NET and ASP.NET projects.
Documentation is created in standard HTML, Microsofts HTML Help (shown in screenshot on left) and plain text formats.
C# Documentation Tool 7.5 offers you a versatile tool to create comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated Microsoft SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Extracts XML comments from source code and incorporates the comments within the codes documentation. Reports are created in standard HTML, Microsoft HTML Help, RTF (compatible with Microsoft Word), XML and plain text formats. Includes documentation, Premium Edition contains source code. VB.NET is also fully supported. Versions for ASP and Visual Basic 6.0 are also available.
The .NET Documentation Tool creates comprehensive technical documentation from Microsoft .NET Framework application source code.
Major Features:
- Documents all types of .NET application, including Windows Forms, Console Applications, Class Libraries and ASP.NET web applications.
- Automates the source code documentation process, saving both time and money.
- Supports .NET Framework 1.0, 1.1, 2.0, 3.0 and 3.5. both C# and VB.NET languages supported. Silverlight/WPF* also supported.
- Special ASP.NET mode 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).
- Produces documentation in HTML, HTML Help (includes alphabetical index and search facilities), plain text, XML and RTF (compatible with Word) formats [view samples].
- Documentation includes the project's colour coded, syntax highlighted, cross-referenced and line numbered source code.
- Optionally uses Visual Studio's XML comments from source code for both VB.NET and C#.
- Documents Microsoft SQL Server 7.0, 2000, 2005 and Microsoft Access databases associated with projects.
- Easy to get up and running - includes Windows installer and full Windows Graphical User Interface.
- Can be run via the Command Line and documentation builds scheduled using the Windows Task Scheduler.
- Ideal alternative to NDoc, which is no longer in active development and does not support .NET 2.0.
- Generous discounts available if you purchase the .NET Documentation Tool together with our documentation tools for SQL Server, ASP or Visual Basic 6.0 [see special offers]. A good value site licensing option is also available.
- The Premium Edition also includes source code.
Requirements: Uses Microsofts HTML Help Workshop (if installed)
WareSeeker Editor
C# Documentation Tool 7.6 is designed as a professional application that creates comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated Microsoft SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Extracts XML comments from source code and incorporates the comments within the codes documentation. Reports are created in standard HTML, Microsoft HTML Help, RTF (compatible with Microsoft Word), XML and plain text formats. Includes documentation, Premium Edition contains source code. VB.NET is also fully supported. Versions for ASP and Visual Basic 6.0 are also available.
Major Features:
- Supports the following project types:
- ASP.NET
- Windows Forms
- Console Applications
- Class libraries
- More than one project can included in the documentation, making it possible to document entire Visual Studio "Solutions".
- For ASP.NET projects, the file parser extracts content from files written in either VB.NET or C#. Supported file types are:
- ASP.NET files (.aspx, .asax).
- User Controls (.ascx).
- Master pages (.master).
- Web Services (.asmx).
- HTTP Handlers/Web Handlers (.ashx).
- Code Behind Files containing the code associated with ASP.NET files and User Controls.
- Custom components (.vb and .cs).
- Web.config files.
- Cascading Style Sheet (CSS) files.
- ASP.NET 2.0 site map files.
- For Windows Forms projects and other non-ASP.NET projects, the file parser extracts content from files written in either VB.NET or C#. Supported file types are:
- Windows Forms (.vb, .cs).
- Custom components/classes (.vb and .cs).
- App.config files.
- Supports most C# and VB.NET XML Comments used by Visual Studio.NET and other code editors.
- Compatible with .NET Framework 1.0, 1.1, 2.0, 3.0 and 3.5 code.
- Silverlight/WPF files are also supported. Note that this technology is still in the early stages of development by Microsoft and may be subject to change.
- Configuration of the .NET Documentation Tool is through the editing of a plain text configuration file [sample].
- Can be scheduled to automatically update project documentation by making use of the Windows AT command or the Task Scheduler.
- Can be integrated with Visual Studio.NET through the Tools menu bar.
- Detailed product documentation in Microsoft's HTML Help format.
- Log file creation shows a comprehensive summary of the .NET Documentation Tool's actions.
- Report shows the following for both VB.NET and C#:
- Namespaces: What namespaces are in the project, and which classes are in each namespace.
- Classes: What classes are in the project, which namespace they belong to and what constructors, functions and subroutines are defined within each class. Partial classes are also supported.
- Enumerators and their properties.
- Properties.
- Constructors: Where they are defined, and which arguments they use.
- Functions: Where they are defined, and which arguments they use.
- Subroutines: Where they are defined, and which arguments they use.
- Additionally for ASP.NET projects:
+ Which User Controls are used in the project.
+ Which Web Controls are used in the project.
+ Which Validation Controls are used in the project.
+ What web.config files are used on the project.
- For Windows projects:
+ What controls are used on Windows Forms.
Where email addresses are located in the project. - SQL Server 7.0, 2000 and 2005 databases associated with the .NET project can also be documented, with the following features:
- Shows a list of tables within the database.
- Shows a list of views within the database.
- Shows a list of column names, type and length associated with each table.
- Shows a list of stored procedures, including the full text of each stored procedure and its input parameters.
- Shows where the stored procedure is called from in code (provided the EXEC keyword is used in SQL statements or the stored procedures are prefixed with "sp_").
- Shows which stored procedures are used in each VB.NET or C# file.
- If you required it, the SQL Documentation Tool can be used to generate even more detailed database developer documentation for SQL Server databases - generous discounts are available if you purchase the SQL Documentation Tool at the same time as the .NET Documentation Tool.
- There are a number of output options:
- Standard HTML: This can be viewed in any web browser [sample], including Internet Explorer and Netscape.
- Microsoft's HTML Help format: This format [sample] has the advantages of:
+ The project documentation is searchable.
+ There is an index of project items.
+ The project documentation can be further modified using Microsoft's freely available HTML Help Workshop application.
+ If the project makes use of Namespaces and Classes, an additional "Class browser" HTML Help file is created in Microsoft's HTML Help format [sample].
- RTF: This documentation is compatible with document processing tools such as Word processors, and make it much easier to print copies of an application's technical documentation. The RTF documents take advantage of the XML comments code commenting system.
- Plain Text: This is a text file containing a summary of the project. As such it can be used as the basis of custom documentation written in a word processor [sample].
- XML: This creates XML documentation in a similar format to that provided using Visual Studio's "XML document file" option (or the /doc:file compiler option). The .NET Documentation Tool does, however have a number of advantages over the facility provided in Visual Studio:
+ It is possible to generate a XML file for any type of project that uses namespaces (even web applications!).
+ Members are listed alphabetically.
+ Members not in Namespaces are included in a "NoNamespace" RTF and XML file.
+ Visual Studio is not required! - The HTML format reports contain full copies of all files which have the following features:
- Optional color coding and syntax highlighting of source code, making it easier to read.
- Optional line numbering of source code.
- There is the option to either colour code or hyperlink all of the following in the source code:
+ Web Control usage.
+ Validation Control usage.
+ Application and Session variable usage.
+ VB.NET and C# functions and subroutines. - Suggested uses of the .NET Documentation Tool:
- Use it as an alternative to NDoc, which was a popular documentation tool for the .NET Framework, but it has not been updated since 2005 and has no support for versions 2.0 and above of the .NET Framework.
- Use it on newly acquired projects to assist in obtaining an overview of that project.
- In this competitive market, why not produce project documentation for your clients? This shows you treat project documentation seriously.
- The .NET Documentation Tool can assist with code reviews and source code audits.
- When making large scale changes to a project, use it to find out where a function or a subroutine is called from.
- Don't let your new hires loose on a project without them having the .NET Documentation Tool's report to help them on their way!
- The color coded, syntax highlighted source code created by the .NET Documentation Tool can be copied and pasted into other documents, making code much easier to read.
- The documentation can be used to complement the comment pages produced by Visual C#.NET.
Enhancements: Added the following new feature:
- The .NET Documentation Tool now supports Constructors in both VB.NET and C#.
Requirements:
- Uses Microsofts HTML Help Workshop (if installed)
WareSeeker Editor
The .NET Documentation Tool creates comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Extracts XML comments from source code and incorporates the comments within the codes documentation. Reports are created in standard HTML, Microsoft HTML Help and plain text formats. Includes documentation, Premium Edition contains source code. VB.NET is also fully supported. Versions for ASP and Visual Basic 6.0 are also available.
Requirements: Uses Microsofts HTML Help Workshop (if installed)
The .NET Documentation Tool creates comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Extracts XML comments from source code and incorporates the comments within the codes documentation. Reports are created in standard HTML, Microsoft HTML Help and plain text formats. Includes documentation, Premium Edition contains source code. VB.NET is also fully supported. Versions for ASP and Visual Basic 6.0 are also available.
Requirements: Uses Microsofts HTML Help Workshop (if installed)
The .NET Documentation Tool creates comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Extracts XML comments from source code and incorporates the comments within the codes documentation. Reports are created in standard HTML, Microsoft HTML Help, RTF (compatible with Microsoft Word), XML and plain text formats. Includes documentation, Premium Edition contains source code. VB.NET is also fully supported. Versions for ASP and Visual Basic 6.0 are also available.
Requirements: Uses Microsofts HTML Help Workshop (if installed)
The .NET Documentation Tool creates comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Extracts XML comments from source code and incorporates the comments within the codes documentation. Reports are created in standard HTML, Microsoft HTML Help, RTF (compatible with Microsoft Word), XML and plain text formats. Includes documentation, Premium Edition contains source code. VB.NET is also fully supported. Versions for ASP and Visual Basic 6.0 are also available.
System Requirements: Uses Microsofts HTML Help Workshop (if installed)
The .NET Documentation Tool creates comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated Microsoft SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Extracts XML comments from source code and incorporates the comments within the codes documentation. Reports are created in standard HTML, Microsoft HTML Help, RTF (compatible with Microsoft Word), XML and plain text formats. Includes documentation, Premium Edition contains source code. VB.NET is also fully supported. Versions for ASP and Visual Basic 6.0 are also available.
System Requirements: Uses Microsofts HTML Help Workshop (if installed)
C# Documentation Tool 7.7 offers you a tool for your documents which creates comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in C# and their associated Microsoft SQL Server/Microsoft Access databases.
Major Features:
- Most types of project (Windows Forms, ASP.NET, etc.) are supported.
- Extracts XML comments from source code and incorporates the comments within the codes documentation.
- Reports are created in standard HTML, Microsoft HTML Help, RTF (compatible with Microsoft Word), XML and plain text formats.
- Includes documentation, Premium Edition contains source code.
- VB.NET is also fully supported.
- Versions for ASP and Visual Basic 6.0 are also available.
Requirements: Uses Microsofts HTML Help Workshop (if installed)
WareSeeker Editor
.NET Documentation Tool 7.4 offers you a useful tool which can help you to create comprehensive documentation for .NET Framework 1.0, 1.1 and 2.0 projects written in VB.NET and C# and associated SQL Server/Microsoft Access databases. Most types of project (Windows Forms, ASP.NET, etc.) are supported. Reports are created in standard HTML, Microsoft HTML Help, RTF (Word compatible), XML and plain text formats.
The .NET Documentation Tool supports XML commented source code. Includes documentation, Premium Edition contains source code. An ASP and Visual Basic 6.0 Documentation Tool are also available - there are discounts when purchased together with the .NET Documentation Tool.
Major Features:
- Documents all types of .NET application, including Windows Forms, Console Applications, Class Libraries and ASP.NET web applications.
- Automates the source code documentation process, saving both time and money.
- Supports .NET Framework 1.0, 1.1, 2.0, 3.0 and 3.5. both C# and VB.NET languages supported. Silverlight/WPF* also supported.
- Special ASP.NET mode 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).
- Produces documentation in HTML, HTML Help (includes alphabetical index and search facilities), plain text, XML and RTF (compatible with Word) formats
- Documentation includes the project's colour coded, syntax highlighted, cross-referenced and line numbered source code.
- Optionally uses Visual Studio's XML comments from source code for both VB.NET and C#.
- Documents Microsoft SQL Server 7.0, 2000, 2005 and Microsoft Access databases associated with projects.
- Easy to get up and running - includes Windows installer and full Windows Graphical User Interface.
- Can be run via the Command Line and documentation builds scheduled using the Windows Task Scheduler.
- Ideal alternative to NDoc, which is no longer in active development and does not support .NET 2.0.
- Generous discounts available if you purchase the .NET Documentation Tool together with our documentation tools for SQL Server, ASP or Visual Basic 6.0. A good value site licensing option is also available.
- The Premium Edition also includes source code.
Enhancements:
- Documents Microsoft Access databases,
- Improved Namespace information
Requirements: Uses Microsofts HTML Help Workshop (if installed)
WareSeeker Editor
The SQL Documentation Tool creates technical documentation for Microsoft SQL Server 7.0, 2000 and 2005 databases. Technical documentation is created in HTML, HTML Help, RTF and plain text 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, Dependencies Full-Text Catalogs, Jobs and DTS Packages. The SQL Server 2005 MS_Description field is fully supported in databases that include it. Free trial version. A source code documentor for the .NET Framework (VB.NET and C#) is also available.
System Requirements: Uses Microsofts HTML Help Workshop (if installed)
The VB Documentation Tool extracts content from Visual Basic 6.0 source code files. It supports the main Visual Basic file types:
Forms
Modules (.bas)
Class Modules (.cls)
Project Groups (.vbg files)
Supports more than one input folder, which is useful if your application is comprised of multiple projects.
The VB Documentation Tool creates documentation which shows the following:
Files associated with the project(s).
Functions: Where they are defined, and where in the project they are called from.
Subroutines: Where they are defined, and where in the project they are called from.
Properties, including where their Get and Let methods are defined.
Constants: Where they are defined, and where in the project they are used.
Databases associated with the project(s).
SQL Documentation Tool 7.1 offers you a great tool which can help you create technical documentation for Microsoft SQL Server 7.0, 2000, 2005 and 2008 databases. Technical documentation is created in HTML, HTML Help, RTF and plain text 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, Dependencies Full-Text Catalogs, Jobs and DTS Packages. The SQL Server 2005 MS_Description field is fully supported in databases that include it. Free trial version. A source code documentor for the .NET Framework (VB.NET and C#) is also available.
Major Features:
The SQL Documentation Tool documents the following items in SQL Server database(s):
- Tables
- Column names.
- Whether the column is a primary key.
- Column data types.
- Column lengths.
- Whether the column is nullable.
- Table relationships to primary and foreign keys.
- Whether there are Triggers associated with the table.
- Table indexes.
- Dependency information.
- Views
- Column names.
- Column data types.
- Column lengths.
- Whether column is nullable.
- Dependency information.
- SQL script for creating each View.
- Stored Procedures
- Column names.
- Column data types.
- Column lengths.
- Column type (input/output)
- Dependency information.
- The Create Procedure SQL script for creating the stored procedure.
- Functions
- Column names.
- Column data types.
- Column lengths.
- Column type (input/output)
- Dependency information.
- The Create Function SQL script for creating the function.
- Triggers
- Shows which table is associated with the trigger.
- Shows which SQL actions (insert, update, delete) the trigger is associated with.
- Dependency information.
- The Create Trigger SQL script for creating the trigger.
- Full-Text Catalogs
- Shows the full-text catalogs that may be associated with a database.
- Shows the tables and table columns in each full-text catalog.
- Extended descriptions. Most entities (tables, stored procedures, table columns etc.) in SQL Server 2005 and above can have descriptions added to them through the SQL Server Management Studio. Where present, the SQL Documentation Tool includes these in the documentation. See the
- SQL Documentation Tool sample documentation for the AdventureWorks database for an example of a fully documented database.
- For each database server documented, the SQL Documentation Tool can optionally include the following:
- DTS Packages
- SQL Server Agent Jobs
+ Steps associated with each job.
+ Each job's schedule. - For convenience the SQL Documentation Tool allows more than one database to be documented in a single help file - the databases can even be located on different servers.
- The Transact SQL code associated with Views, Stored Procedures and
- Triggers is included in the documentation created by the SQL
- Documentation Tool. This SQL can be optionally colour coded and syntax highlighted for easy reference.
Enhancements:
- In response to user demand, the SQL Documentation Tool now has options to specify what should be documented in a project. It is now possible to document all/some or none of the following: tables, views, stored procedures, triggers, full-text catalogs, indexes, jobs and DTS packages.
Requirements:
- Uses Microsofts HTML Help Workshop (if installed)
WareSeeker Editor
SQL Documentation Tool 7.0 is a powerful software for managing documents. For more information please read the description below.
The SQL Documentation Tool creates technical documentation for Microsoft SQL Server 7.0, 2000, 2005 and 2008 databases.
Technical documentation is created in HTML, HTML Help, RTF and plain text 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, Dependencies Full-Text Catalogs, Jobs and DTS Packages. The SQL Server 2005 MS_Description field is fully supported in databases that include it. A source code documentor for the .NET Framework (VB.NET and C#) is also available.
For convenience the SQL Documentation Tool allows more than one database to be documented in a single help file - the databases can even be located on different servers.
The Transact SQL code associated with Views, Stored Procedures and Triggers is included in the documentation created by the SQL Documentation Tool. This SQL can be optionally colour coded and syntax highlighted for easy reference.
Major Features:
- Reports are created in a number of formats: Standard HTML; Microsoft's HTML Help; RTF (Word compatible document); Text
- Standard HTML: The HTML report is created using standard HTML and may be viewed in any web browser [view a sample].
- Microsoft's HTML Help: HTML Help is the standard file format used by most Windows applications to present their help documentation.
- RTF: The RTF format report is compatible with word processers such as Microsoft Word.
- The plain text report contains a listing of the principal items in the database - tables, views, stored procedures and full-text catalogs.
Requirements: Uses Microsofts HTML Help Workshop (if installed)
WareSeeker Editor
The SQL Documentation Tool creates technical documentation for Microsoft SQL Server 7.0, 2000 and 2005 databases. Technical documentation is created in HTML, HTML Help, RTF and plain text 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, Dependencies Full-Text Catalogs, Jobs and DTS Packages. The SQL Server 2005 MS_Description field is fully supported in databases that include it. Free trial version.
Requirements: Uses Microsofts HTML Help Workshop (if installed)
Many DBAs understand the requirement for documentation, for sql databases overview and management protocol purposes, for example. However, the arduous task is often left unfinished as, in itself, it is a time-consuming and tedious job that doesn?t offer great or immediate benefit to the documenter. SQL Documentation Tool provides a simple solution to this, by connecting to databases and outputting documentation in HTML format that is easy on the eye.
Includes documentation, Premium Edition contains source code. An ASP Documentation Tool is also available - there are discounts when purchased together with the ASP.NET Documentation Tool.
Sample documentation produced by the current version of the ASP.NET Documentation Tool for a variety of projects can be seen by choosing the following selection of links:
SampleWeb.NET (VB.NET & C#) [HTML] [Text] [HTML Help - Full, Class Browser]
IBuySpy Portal (C#, Visual Studio version) [HTML] [Text] [HTML Help - Full, Class Browser]
IBuySpy Store (VB.NET, SDK version) [HTML] [Text] [HTML Help - Full, Class Browser]
Windows application sample documentation may be viewed on the VB.NET
Documentation Tool page (C# example coming shortly!).
Although Visual C#.NET has the ability to create code comment [sample], the ASP.NET Documentation Tools are much more comprehensive.
ASP.NET Documentation Tool is a software that creates project documentation.
Here are some key features of "ASPNET Documentation Tool":
ASP.NET file parser extracts content from files written in either VB.NET or C#. Supported file types are:
ASP.NET files (.aspx, .asax).
User Controls (.ascx).
Code Behind Files containing the code associated with ASP.NET files and User Controls.
Custom components (.vb and .cs).
Web.config files.
NEW! Supports many of C#s XML Comments used by Visual Studio.NET and other code editors.
Want to place your software product here?
Please contact us for consideration.
Contact WareSeeker.com