KIELER Project


Get me back to the home page!

Page tree

Versions Compared

Old Version 5

changes.mady.by.user Michel Spils

Saved on

compared with

New Version 6

changes.mady.by.user Unknown User (cds)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In the KIELER project we are conducting regular code reviews of (possibly) all of our sources. To make things easier, we do software assisted reviews in Crucible.

On this page:

Table of Contents

Review Scheme

Reviews are scheduled for every thursday. In the weekly KIELER meeting one author and two reviewers are chosen.

...

http://rtsys.informatik.uni-kiel.de/~kieler/rating/ 

Tag Syntax

The complete syntax of the available tags is as follows:

Code Block
@kieler.design [proposed] yyyy-mm-dd comment
   Marks a class as design-reviewed or to be design-reviewed. For proposed classes, the
   comment should mention the login name of the person proposing the class to be reviewed.
   For reviewed classes, the comment should include the names of the reviewers.

@kieler.rating [proposed] <yellow|green> yyyy-mm-dd comment
   Marks a class as code-reviewed or to be code-reviewed. For proposed classes, the
   comment should mention the login name of the person proposing the class to be reviewed.
   For reviewed classes, the comment should include the names of the reviewers as well as
   the ID of the review in Crucible (for instance "KI-15").

@kieler.ignore comment
   Marks a class as to be ignored in the code rating statistics. The comment should provide
   an explanation of why the class is ignored.

To be compatible with past tags, the doclet is actually quite flexible in terms of what it still accepts. However, it is good practice to follow these recommendations.