Subversion Repositories DevTools

Rev

Rev 1295 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1293 dpurdie 1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
2 
<HTML
3 
><HEAD
4 
><TITLE
5 
>Viewing Comments</TITLE
6 
><META
7 
NAME="GENERATOR"
8 
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
9 
REL="HOME"
10 
TITLE="The Codestriker Guide"
11 
HREF="book1.html"><LINK
12 
REL="UP"
13 
TITLE="User's Guide"
14 
HREF="c333.html"><LINK
15 
REL="PREVIOUS"
16 
TITLE="Reviewing Topics"
17 
HREF="x504.html"><LINK
18 
REL="NEXT"
19 
TITLE="Topic Properties"
20 
HREF="x624.html"></HEAD
21 
><BODY
22 
CLASS="SECT1"
23 
BGCOLOR="#FFFFFF"
24 
TEXT="#000000"
25 
LINK="#0000FF"
26 
VLINK="#840084"
27 
ALINK="#0000FF"
28 
><DIV
29 
CLASS="NAVHEADER"
30 
><TABLE
31 
SUMMARY="Header navigation table"
32 
WIDTH="100%"
33 
BORDER="0"
34 
CELLPADDING="0"
35 
CELLSPACING="0"
36 
><TR
37 
><TH
38 
COLSPAN="3"
39 
ALIGN="center"
40 
>The Codestriker Guide: Version 1.9.3</TH
41 
></TR
42 
><TR
43 
><TD
44 
WIDTH="10%"
45 
ALIGN="left"
46 
VALIGN="bottom"
47 
><A
48 
HREF="x504.html"
49 
ACCESSKEY="P"
50 
>Prev</A
51 
></TD
52 
><TD
53 
WIDTH="80%"
54 
ALIGN="center"
55 
VALIGN="bottom"
56 
>Chapter 3. User's Guide</TD
57 
><TD
58 
WIDTH="10%"
59 
ALIGN="right"
60 
VALIGN="bottom"
61 
><A
62 
HREF="x624.html"
63 
ACCESSKEY="N"
64 
>Next</A
65 
></TD
66 
></TR
67 
></TABLE
68 
><HR
69 
ALIGN="LEFT"
70 
WIDTH="100%"></DIV
71 
><DIV
72 
CLASS="SECT1"
73 
><H1
74 
CLASS="SECT1"
75 
><A
76 
NAME="VIEW-COMMENTS"
77 
>3.6. Viewing Comments</A
78 
></H1
79 
><P
80 
>        From the "View Topic" page (see <A
81 
HREF="x504.html#VIEW-TOPIC"
82 
>Section 3.5.1</A
83 
>),
84 
        the "Topic Comments" tab can be clicked to
85 
        view the comments associated
86 
        with a topic.  This can be clicked at any stage to see what
87 
        comments have been submitted against a review.  It is often
88 
        necessary for the author once a review has been completed, to
89 
        work their way through the comments from the browser, although
90 
        they can do this with their email client as well (assuming
91 
        <CODE
92 
CLASS="VARNAME"
93 
>$allow_comment_email</CODE
94 
> is true in
95 
        <TT
96 
CLASS="FILENAME"
97 
>codestriker.conf</TT
98 
>), since each comment
99 
        will generate an email message.  An example screenshot of the
100 
        "Topic Comments" page can be seen in <A
101 
HREF="x602.html#FIGURE-VIEWCOMMENTS"
102 
>Figure 3-10</A
103 
>.
104 
        <DIV
105 
CLASS="FIGURE"
106 
><A
107 
NAME="FIGURE-VIEWCOMMENTS"
108 
></A
109 
><P
110 
><B
111 
>Figure 3-10. Topic Comments Screenshot</B
112 
></P
113 
><DIV
114 
CLASS="MEDIAOBJECT"
115 
><P
116 
><IMG
117 
SRC="viewcomments.png"></P
118 
></DIV
119 
></DIV
120 
>
121 
      </P
122 
><P
123 
>        A separate heading is shown in the display, for each comment
124 
        thread, which represents a series of comments made against a
125 
        specific code line.  For each thread, all of the comments made
126 
        are shown, including author and date information.  For each
127 
        comment thread, the current values of the comment metrics
128 
        associated with the thread will be displayed.  In this
129 
        example, there is only a single comment metric clled "Status".
130 
        The metric values associated with the thread can be updated by
131 
        changing the value of the metric dropdowns, and clicking the
132 
        "Update" button at the bottom of the page.
133 
      </P
134 
><P
135 
>	For each comment thread, there are three links to other
136 
	Codestriker screens.  The first link will bring up a "View
137 
	File" page (see <A
138 
HREF="x504.html#VIEW-FILE"
139 
>Section 3.5.3</A
140 
>) centered on the
141 
	line number of the comment, "Parallel" will do the same, by
142 
	using the parallel view, and the "Add comment" link will bring
143 
	up the "Add Comment" window (see <A
144 
HREF="x504.html#ADD-COMMENT"
145 
>Section 3.5.2</A
146 
>)
147 
	for that line number.
148 
      </P
149 
><P
150 
>        In this particular example, there are two comment blocks, for
151 
        file <TT
152 
CLASS="FILENAME"
153 
>codestriker/codestriker.pl</TT
154 
>, on lines
155 
        27 and 60.
156 
      </P
157 
><P
158 
>        At the top of this page are a number of filtering options,
159 
        which control what comments are displayed.  Comments can be
160 
        filtered by the author of the comment and/or specific comment
161 
        metric values.  In addition, for each comment block, it is also
162 
        possible to display the context of the topic text the comment
163 
        block is made against (as is done for the "Add Comment" page,
164 
        see
165 
        <A
166 
HREF="x504.html#ADD-COMMENT"
167 
>Section 3.5.2</A
168 
>).  These controls provide the
169 
        capability for generating code review reports, which can then
170 
        be used at code inspection meetings.
171 
      </P
172 
></DIV
173 
><DIV
174 
CLASS="NAVFOOTER"
175 
><HR
176 
ALIGN="LEFT"
177 
WIDTH="100%"><TABLE
178 
SUMMARY="Footer navigation table"
179 
WIDTH="100%"
180 
BORDER="0"
181 
CELLPADDING="0"
182 
CELLSPACING="0"
183 
><TR
184 
><TD
185 
WIDTH="33%"
186 
ALIGN="left"
187 
VALIGN="top"
188 
><A
189 
HREF="x504.html"
190 
ACCESSKEY="P"
191 
>Prev</A
192 
></TD
193 
><TD
194 
WIDTH="34%"
195 
ALIGN="center"
196 
VALIGN="top"
197 
><A
198 
HREF="book1.html"
199 
ACCESSKEY="H"
200 
>Home</A
201 
></TD
202 
><TD
203 
WIDTH="33%"
204 
ALIGN="right"
205 
VALIGN="top"
206 
><A
207 
HREF="x624.html"
208 
ACCESSKEY="N"
209 
>Next</A
210 
></TD
211 
></TR
212 
><TR
213 
><TD
214 
WIDTH="33%"
215 
ALIGN="left"
216 
VALIGN="top"
217 
>Reviewing Topics</TD
218 
><TD
219 
WIDTH="34%"
220 
ALIGN="center"
221 
VALIGN="top"
222 
><A
223 
HREF="c333.html"
224 
ACCESSKEY="U"
225 
>Up</A
226 
></TD
227 
><TD
228 
WIDTH="33%"
229 
ALIGN="right"
230 
VALIGN="top"
231 
>Topic Properties</TD
232 
></TR
233 
></TABLE
234 
></DIV
235 
></BODY
236 
></HTML
237 
>