|Chapter 11. Checklists|
Most projects have their own coding standards which define naming conventions, restrict language usage and define rules and recommendations for the use of the language. These rules have to be checked during the review and to make life easier QuickRev supports the direct usage of checklists.
Loading Of Checklists
-checklist <checklist-files>. You can specify as many checklists as you like.
resourcesdirectory of the
QuickRev.jarfile. To detect these checklists they have to follow the following file name rule:
indexhas to start with null. Examples:
Usage Of Checklists
To assign a rule to a comment, a comment has to be selected in the comment dialog. The assignment can be done via the context menu item Add To Selected Comment, via double click at the rule to be assigned or via the enter-key. If a rule is assigned to a comment the comment field is not mandatory anymore, so no additional description has to be made.
To remove a rule from a comment use the x button behind the rule in the comment dialog.
To find rules faster they can be marked as favourites. Afterwards Show Favourites
hides all rules not marked as favourites, another click on the button respectively menu item shows all rules again.
The favourite rules will be saved in the users
.quickRev/config/main file, so after a restart of QuickRev
they are available again.
Use Expand All or Collapse All to expand respectively collapse all rules.
If you have selected some favourite rules already, you can selected these rules easily via the FavRule button in the comment dialog, which brings up the following dialog where the rule can be selected easily.
Creation Of Checklists
checklist.xsd. A checklist example file
checklist_example.xmlis delivered with QuickRev which can be used to check out the checklist feature or as a base for own checklists. To view the checklists in a browser independently of QuickRev you can specify a stylesheet (e.g. the delivered
checklist.xsl) within your checklist file (like done in the checklist example file).
|Copyright © 2008 - 2016 Tom Seidel||Last Update: 2016-11-5|