|
After performing analysis on a set of source files, you would like to view the comments generated by JStyle. There are convenient reporting formats available to do this. One of the most useful is the spreadsheet format. This gives in a table form all comments (from the ones that are enabled) that are applicable to the current project. See the figure below.
Fig. 5.1 The comment ID, its classification, its context, and its severity are displayed in this table. If you click on a specific comment ID or its file name, the editor automatically opens the file with the context in focus. HTML and text formats are also supported. If HTML format is selected (Reports->Comment Reports->HTML Format), you will be prompted to specify a directory to write the html files. If Internet Explorer is installed on your machine, JStyle automatically displays the reports in browser mode. See the following figure for a sample view.
Fig. 5.2 If you wish to store the generated comments in a database for offline processing, you can choose Reports->Comment Reports->Export to Database. This creates an .mdb file that can be manipulated using Microsoft AccessTM. If you choose Reports->Comment Reports->Text Format, you will be prompted as follows:
Fig. 5.3 After you enter the various parameters and click OK, the report will be saved as a text file. The information written in the text file as well as its structure can be configured through the menu option Reports->Comment Reports->Report Format. This brings up a dialog as shown in the following figure.
Fig. 5.4 You can select the required fields that should go into the report.
|
