gov.sandia.cognition.annotation

Annotation Type CodeReview

@CodeReview(reviewer="Kevin R. Dixon",
            date="2008-02-08",
            changesNeeded=true,
            comments={"Not sure about the Documented or Runtime Retention annotations for the class.","Otherwise, class looks fine."},
            response=@CodeReviewResponse(respondent="Justin Basilico",date="2008-02-18",moreChangesNeeded=false,comments={"Runtime retention means that we could look via reflection to see what has been code reviewed.","Documented makes the review show up in the documentation."}))
 @Retention(value=RUNTIME)
 @Documented
public @interface CodeReview

The CodeReview annotation describes information about the last code review for a piece of code.

Since:

2.1

Author:

Kevin R. Dixon, Justin D. Basilico

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
boolean	changesNeeded True if the review determined changes are needed in the code.
java.lang.String	date The date of the review.
java.lang.String[]	reviewer The full name of the reviewer of the code.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	comments Comments from the code review.
CodeReviewResponse[]	response Response(s) to a code review.

Element Detail

reviewer

public abstract java.lang.String[] reviewer

The full name of the reviewer of the code. For example, "Justin Basilico".

Returns:

The full name of the reviewer.

date

public abstract java.lang.String date

The date of the review. Use "YYYY-mm-dd" format. For example, "2008-01-14".

Returns:

The date of the code review.

changesNeeded

public abstract boolean changesNeeded

True if the review determined changes are needed in the code. Otherwise, false.

Returns:

True if the review determined are needed in the code.

comments

public abstract java.lang.String[] comments

Comments from the code review. If changesNeeded is specified, there should be at least one comment.

Returns:

Comments from the code review.

Default:

{}

response

public abstract CodeReviewResponse[] response

Response(s) to a code review.

Returns:

The response to the code review.

Default:

{}