Programming languages such as C# and Visual Basic support the creation of XML Documentation Comments, allowing developers to quickly annotate and document their source code to keep the documentation in a standard format and to gain benefit from the information as you code. Documentation is important to ensure that developers can quickly learn and use the source code.
IDE Tools User Guide supports static and dynamic content. The static text is stored inside the “*.htm” files, and the pictures are stored in the independent files in the appropriate format (gif, jpeg, png, etc). The static content can be manually edited right inside of the User Guide. There are also two DXCore controls useful for population dynamic content. These controls are the Tutorial Page Provider and Tutorial Content Provider. In this article, we’ll add some static content to the built-in CodeRush Documentation shown inside User Guide, and provide some dynamic content using the Tutorial Content Provider component.
The User Guide documents the DXCore and dependent products (such as CodeRush and/or Refactor! if they’re installed) and also includes documentation covering Visual Studio extensibility. This tutorial can be viewed by selecting “User Guide…” from the DevExpress menu. You can also view it by selecting “Guide” from the DevExpress | Tool Windows menu.
You may look at the following information resources to learn more about IDE Tools products:
1) Online help for IDE Productivity Tools.
2) User Guide available via the “DevExpress | User Guide” menu after IDE tools are installed.