Document! X for C# Documentation
Document! X is a combination of an automated C# documentation tool and a full documentation authoring environment which can be used to create accurate, professional quality documentation for assemblies created with C# or any other .NET language.
Document! X is the .NET documentation tool chosen by leading .NET component vendors including Infragistics, Xceed, Telerik, Dundas, Janus, Farpoint and GrapeCity.
- Fast, accurate, professional quality documentation;
- Market leading authoring tools for creating supplementary content;
- Automatically integrates the generated documentation with the Visual Studio F1 Help and Dynamic Help Window;
- Documentation pages generated for assembly, namespace, class, interface, structure, enumeration, constructor, method, property, field, delegate;
- Generate documentation to HTML Help 1.x (CHM), Help 2.x, Microsoft Help Viewer or web ready pure HTML including a full Table of Contents, Index and Full Text Search.
- Customizable HTML based template driven output can be adapted to your requirements and ships with standard phrases pre-translated to 9 different languages;
Document! X is not just an automated C# documentation build tool - it is also includes a fully featured documentation authoring environment allowing you to create supplementary content (descriptions and remarks for Namespaces, Classes, Interfaces, Enumerations, members, hyperlinks to related pages, example code, index kewords etc.) where required.
Download a free evaluation version
Author content in XML source comments and / or externally
Author C# XML comments in Visual Studio in a Visual Comment Editor
Document! X makes C# XML comments easier to work with by including a Visual Comment Editor integrated with Visual Studio (2010 and 2012). The Visual Comment Editor allows you to work within a preview of the generated documentation page whilst still reading and writing the content to and from source in standard C# XML comment format. If you prefer, you can continue to author C# XML source comments manually.
Document! X will use any C# XML source comments where they are available - including all of the comment types that Microsoft define in the XML comment specification for C#.
XML comment editor (Document! X Visual Studio integrated Comment Editor)
Click here to view a movie showing the Document! X Visual Studio Comment Editor in action
Author content in a Document! X Content File
You can also author content outside of C# source code if you wish, or combine both approaches and have some content in C# source XML comments and some in Document! X Content Files.
This approach is quite common as it allows technical writers to contribute more extensive content or examples, or override content defined in source comments for editorial reasons, without stopping developers from documenting in the source.
Content File Editor for .NET documentation
The same great authoring environment, including dynamic spell check, hyperlink designer and designers for example code, permissions, exceptions, index keywords etc. are available both in the Visual Studio Integrated C# Visual Comment Editor and in the Document! X Content File Editor.
Benefits of using Document! X
Using Document! X as your .NET documentation tool immediately delivers the following benefits:
- C# .NET documentation can be built by Document! X in moments, reducing the amount of manual effort involved in creating a documentation set to virtually zero;
- The Visual Comment Editor integrated with Visual Studio dramatically simplifies the process of documenting in C# source code and gives the developer a view of the whole documentation page which makes it easy to spot gaps in the documentation and typos;
- The documentation generated by Document! X is accurate and always up to date. Creating the same documentation manually is error prone and very labor intensive;
- Documentation for the assembly you have documented is immediately available in Visual Studio using F1 or the Dynamic Help window;
- Producing a documentation set for your .NET assembly makes it more maintainable as there is a structured reference to accompany the source code and API;