Document! X is a combination of an automated VB (VB.NET) documentation tool and a full documentation authoring environment which can be used to create accurate, professional quality documentation for assemblies created with VB.NET or any other .NET language (C#, F#, C++/CLI etc.).
Document! X is not just an automated VB.NET 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 keywords etc.) where required.
These sample outputs illustrate how much 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.
Overview of a .NET class, including an automatically generated Object Relationship Diagram, Inheritance Hierarchy and Syntax in multiple .NET languages.
Page for a specific .NET constructor overload, including a link to the method summary page listing other overloads.
Overview of the COM class, including an automatically generated Object Relationship Diagram.
Page generated for an XSD Complex Type, including a type diagram, overview data tree and XSD Source Code.
Page generated for a Table, including Properties, Columns, Indexes, Relationships and SQL Source (where available). Also includes dependencies if documenting a Sql Server database.
Page generated for a GET Operation in a REST Web Service. Details the parameters, request/response data types and any fault responses.
Page generated for a SOAP Web Service method. Details the parameters, request/response data types and any fault responses.
Schema diagrams are automatically generated for web service operations that use XSD Types and XSD documentation pages.
Document! X makes VB XML comments easier to work with by including a Visual Comment Editor integrated with Visual Studio® 2010-2019.
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 .NET XML comment format. If you prefer, you can continue to author VB XML source comments manually.
The Document! X Visual Studio Visual Comment Editor provides a unique fully Visual Editor for your VB.NET, C# or C++/CLI source code comments, integrated directly with the Visual Studio IDE. The Visual Comment Editor allows you to create and edit Xml comments in a WYSIWYG preview of the generated documentation.
Even though you can author your content in a fully WYSIWYG editor, comments created or edited with the Visual Comment Editor are written back to your source code in standard XML source comment format.
Document! X can document assemblies created with any Visual Studio language. The Visual Comment Editor supports C#, Visual Basic, C++/CLI and F# projects.
Build your documentation projects directly from Visual Studio. Integrate Document! X with your team build using the provided command line build .exe, msbuild task or Workflow activity.
Document! X will use any VB XML source comments where they are available - including all of the comment types that Microsoft define in the XML comment specification for VB and C#.
You can also author content outside of VB source code if you wish, or combine both approaches and have some content in VB 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.
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 VB.NET Visual Comment Editor and in the Document! X Content File Editor.
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.
These short movies provide a great way to discover what can be achieved using Document! X.
This movie will take you through the process of producing documentation from an XSD Schema file using Document! X. (10 mins)
This movie will take you through the process of producing documentation for a Web Service (SOAP or REST) using Document! X. (11 mins)
This introductory movie will take you through the process of creating a new Document! X Project for one or more Microsoft .NET Assemblies (13 minutes).
This short introductory movie will take you through the process of creating a new Document! X Project for a Database (7 minutes).
This short introductory movie will take you through the process of creating a new Document! X Project for a COM Component or Type Library (6 minutes).
This movie demonstrates the new Publishing functionality introduced in 2015.1. Publishing makes it easy to publish output generated by Document! X or HelpStudio to a web server or network location. A range of publishing methods are supported; you can publish to an Azure web site, a web site running on IIS, a web site that supports uploading via ftp, or directly to a local network path. (11 mins)
This video demonstrates how the Responsive Output feature allows you to generate content that automatically adapts to the device type of the browser, providing an optimal experience for Mobile, Tablet and Desktop users from a single output. (5 mins)
This short video provides a demonstration of how you can configure a project to create multiple outputs from a single source, with each output driven by a separate options defined in the Build Profile. (3 minutes)
Using Document! X as your VB documentation tool immediately delivers the following benefits: