Commenting on reviews
Comments are at the core of the review experience – reviewers use comments to record discussion around suggested and required changes to the code.
Comments can be added at the level of a review, a file, or a line. Of course, you can also reply to comments.
On this page:
Locating existing comments
Use the Review Activity
The easist way to browse for comments is to use the Review Activity – click Activity when viewing the review (or use the keyboard shortcut 'shift' + ']'):
The Review Activity shows all the latest comments on the review, so it's easy to catch up on the review, or to find outdated or hidden comments.
The bubble beside the Activity link shows the number of unread comments.
Scroll through the comments or use the keyboard shortcuts:
- 'n' – go to the next comment
- 'p' – go to the previous comment
- 'shift' + 'n' – go to the next unread comment
- 'shift' + 'p' – go to the previous unread comment
Click Mark as read or Mark as unread (or use the 'm' keyboard shortcut) to toggle the comment status.
To see the comment in context just click it (or press the 'return' key) to go to the file where the comment was made.
Use the date link for a comment to connect others to the comment:
Use the file tree
The number beside a filename, in the left-hand panel of a review, indicates the number of comments on that file.
(The number of unread comments, if any, is shown in brackets.)
Adding comments
There are various types of comments that you can add in Crucible:
| To comment on... | Do this... | |
| The whole review | Click General Comments (in the left-hand panel), and simply type your comment (under 'General Comments'). |  |
| A source file under review | Click on the file in the left-hand panel, then click Add a file comment (just above the source code listing). |  |
| Lines of code | Click on a line of code in the displayed source file of a review.
| |
| A revision or changeset |
To reply to a comment, click Reply at the bottom of the comment.
Only people with the 'Comment' permission can add comments. A comment can only be deleted by the author of the comment.
Read about flagging defects too.
Draft comments
You can save your comment as a draft and then edit it later. When you complete the review, you will be prompted to post, discard or edit any remaining draft comments.