Visual Expert can automatically document your code.
The end result is a very comprehensive HTML documentation, detailing every object and its dependencies throughout your application. It can be used as reference manuals for code maintenance, review purpose, and knowledge transfer.
For more details, you can checkout the following samples:
You can schedule the documentation on a regular basis (daily, weekly, monthly) or on a specific time, when your machine is not busy.
This section allows you to indicate the path, content, style, template and language before generating the documentation.
Configure a path from your harddrive to save the documentation.
Click on ‘Browse Folders’ to change the path.
Visual Expert allows you to create a custom style for your HTML documentation.
Click on ‘Edit Styles’ to create a new style. In the dropdown change ‘Novalys Default Style’ with your custom style.
Select documentation template as ‘Reference Documentation’ or ‘Code Review’.
By default Visual Expert generates the documentation for the whole project.
If you need to document only a part of your project, you can select the option ‘Selected Items Only’ in this dropdown.
The documentation will be generated only for the components selected in the Main View.
Select the documentation language from these options - English, French, Spanish and Japanese.
This window allows you to filter out the component types included in the documentation according to their type.
As shown above, for each chosen component type, you can also filter out one or more details as needed.
The changes will be saved for all future documentations for this project on clicking ‘OK’.
This subsection allows you to schedule the documentation daily, weekly, monthly or on a specific time.
Visual Expert considers the current settings for path, style, template, content and language while generating the scheduled documentation.
Four buttons are provided at the bottom of the Documentation center. Usage of each is as shown below:
Homepage of a sample Reference Documentation created for a PB + SQL server project
Visual Expert can also generate Code Review Reports.
Please check-out the following samples:
You can generate such a report...
In order to create a code review documentation, follow the steps given below:
You can filter the content of the code review documentation by selecting only the required component types and parts of the documentation. For that, click on the “Adjust Content” button to open the documentation content settings.
For example, below selection will only generate code review documentation for unused and uncommented procedures.
Homepage of a sample code review documentation created for a PB + SQL server project