Documentation Insight
Keywords: Delphi XML Documentation, Delphi XMLDoc Comments, Delphi Documentation Tool
Help you visually read and write xml documentation in the Delphi / RAD Studio IDE. It’s the most powerful Delphi XML Documentation Tool(Plug-in or Add-in).
Introduction
The first step in understanding source code is reading its documentation. Professional documentation helps to easily get the key points and understand the design intention of the author. Furthermore, when we play the role of an author, we also need to write documentation to explain our code and design intentions, especially when working with other developers.
We prefer XML style documentation which is originally introduced in .Net(also mentioned as C# style documentation), since it has been supported by the Delphi IDE since Delphi 2006, and the built-in Help Insight feature can show documentation when we move the cursor over a code element.
However, with Documentation Insight, you don’t need any knowledge of XML documentation. By using its impressive WYSIWYG editor, you can natually write xml documentation, and Documentation Insight can generate well-formed xml documentation, instantly updating your source code. Documentation Insight takes advantage of regions to manage the documentation, which keeps your source code clean.
In addition, Documentation Insight will try extracting simplified documentation from local VCL Help Documentation when you opened a VCL unit. You are able to explore the source code while reading its documentation and all links in the documentation can be navigated in a second. How amazing!
Features
- WYSIWYG xml documentation editor
- Live Documentation Explorer
- Live Spell Check
- Documentation Formatter
- Documentation Validation
- Support most common XML tags
- Support collapsible region to manage documentation
- Synchronization between code and documentation
- Integration with VCL API Documentation
- Integration with Help Insight
- Hyperlink Navigation
- Customizable Region styles
- Several note styles
- Code Snippet editor
Required Environment
- Delphi 7, RAD Studio 2007/2009/2010/XE/XE2
- Internet Explorer 7.0 or higher
- MSXML 6.0
Try it now, and you will wonder how you ever lived without it!
Comments