☰ Menu
☰ Menu
The Document! X Visual Studio Visual Comment Editor provides a unique, fully visual editor for your VB.NET, C#, F#, or C++/CLI source code comments. Integrated directly with the Visual Studio IDE, the Visual Comment Editor allows you to create and edit comments directly within an editable preview of the generated documentation. Comments created with the Visual Editor are written back to your source code in standard XML format.
Document! X commands added to the Visual Studio toolbar and solution explorer context menu make it quick and easy to edit comments and build a documentation project right from within Visual Studio.
These sample outputs illustrate output which can be generated by Document! X right out of the box. All of the Document! X templates are fully customizable and can be easily adapted or extended to meet your specific requirements.
If you have created XML comments in your Java source code, Document! X can use them automatically and you can view the XML source comments while you are editing to spot areas that might need expansion or replacement.
You can also choose to author content in the Document! X Content File Editor. Content can be configured to extend (combine with) or override any existing source comments according to your preference. This approach allows you to include basic documentation in the source code and use the rich Document! X Content File Editor to supplement it with examples, more detailed descriptions etc.
Document! X will automatically populate the description of members inherited from other assemblies or the .NET Framework to minimize documentation authoring effort.
Document! X automatically generates object relationship diagrams for your classes. Specific relationships can be ignored where necessary (e.g. a relationship back to a parent object). Collection objects are automatically recognized and appropriately represented.
Your documentation projects can be generated to Web Help, Help 2.x (Visual Studio® 2002-2008) or Microsoft Help Viewer (Visual Studio® 2010-2022). The specific requirements for the different output formats are handled automatically and you can build all outputs from a single project. Automatic publishing makes it quick and simple to deploy the generated output to your website, FTP server, or network location.
Templates are provided for the Visual Studio documentation styles so that users of the documentation you produce will be familiar with the structure, layout, style, and functionality.
Generated documentation supports language filtering so that any language-specific reference information such as syntax tables and examples will be filtered according to the chosen language(s). For example, if your users are programming in C#, they can choose to view the C# syntax definition and examples. The language filtering functionality implemented by Document! X is ‘sticky,’ such that a language preference is preserved when navigating between pages.
F1 support is automatically generated, so your assembly documentation is always only a keypress away for developers.
Document! X can automatically ‘Plug In’ the generated Microsoft Help 2.x (Visual Studio 2002-2008) or Microsoft Help Viewer (Visual Studio 2010-2022) file to the Visual Studio Help collection on the local machine so that the generated Table of Contents and Index are merged into the Visual Studio Help collection (this option is set on the ‘Help Compiler Options’ page of the Document! X Project Editor).
Document! X also ships with a command-line tool to assist in registering Microsoft Help 2.x files on other machines and generates .bat files for registration and un-registration automatically.
If your assembly is written in a .NET language that does not generate an XML documentation file during compilation, you will find that when using the assembly in Visual Studio Intellisense does not display a description. Document! X solves this problem by optionally generating an XML comment file as part of the documentation build process, enabling descriptions in both Intellisense and the Object Browser.
The easy-to-use Example Code Designer included in the Content Editors makes adding multi-language examples a breeze. In-line or linked examples can be created and example code is automatically colorized in the generated output.
Document! X supports several different languages (English, French, German, Dutch, Italian, and Russian) for the phrases used in the generated output. All of the phrases and terminology in the generated output can be configured according to preference.
Document! X allows you to author content for multiple languages within a single project, showing you an embedded tip for the primary locale content when you are authoring in the Content File Editor for a secondary locale. If you use the Document! X and HelpStudio bundle you can export and import your localized content in XLIFF format; the industry standard for sharing content with translation providers.