|
General
- Supports VB .NET and C# in any type of project, including class library, application, smart device, ASP .NET.
- Works with Visual Studio .NET 2002 / 2003 / 2005.
- Full support for generics in VS 2005.
- Works in GUI and command line modes.
-
No need for compiled assemblies. Everything is extracted directly from
the source code. This is especially useful for ASP .NET projects.
- You can select which members will be documented using filtering by type, accessibility or project file.
-
Conditional compilation. You can define conditional constants and add
condition to the member comment. This way you can include or exclude
specific members from documentation.
Commenting
- Supports standard XML comments and Javadoc comments.
- Contains sophisticated WYSIWYG
comment editor.
- You can automatically insert default XML comment to the member.
-
You can automatically insert Description attribute to your property.
This is used for property short description in Properties Window.
- You can insert tables, lists, pictures, links, colors, bold, italics and other formatting directly in your source code.
-
Supported comment tags: <summary>, <seealso>,
<example>, <same>, <typeparam>, <param>,
<set>, <returns>, <remarks>, <author>,
<version>, <revision>, <includesource>,
<compilewhen>, <exception>, <value>, <para>,
<code>, <c>, <see>, <list>, <img>,
<b>, <i>, <u>, <font> and user-defined tags.
Output
- Generates the following documentation formats:
-
Help 2 - the latest Microsoft help technology used in Visual
Studio .NET, .HxS file. Old and new MSDN look.
-
HTML Help 1.x
- .CHM file. Old and new MSDN look.
-
HTML - files with Java index and table of contents. Old and new
MSDN look.
-
RTF
document.
-
XML
which can be processed later by
other tools
-
Others. The user is allowed to define his own format for any text based document such as LATEX, custom
HTML and others.
- Generates IntelliSense (auto-completion tooltips) and Object Browser info.
- Creates F1 help.
- Integrates in VS help system on target computer.
- Easily deploys Help2 documentation to target computers using accompanied royalty-free command-line utility.
- Output is localizable. There are several built-in languages including English, German, French and Spanish.
- Creates links to frameworks classes, even for HTML and CHM output.
- Documentation can contain source code of the member.
|