Subversion Repositories DevTools

Rev

Rev 1293 | Blame | Last modification | View Log | RSS feed 

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Viewing Comments</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Codestriker Guide"
HREF="book1.html"><LINK
REL="UP"
TITLE="User's Guide"
HREF="c333.html"><LINK
REL="PREVIOUS"
TITLE="Reviewing Topics"
HREF="x504.html"><LINK
REL="NEXT"
TITLE="Topic Properties"
HREF="x624.html"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Codestriker Guide: Version 1.9.3</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="x504.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 3. User's Guide</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x624.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="VIEW-COMMENTS"
>3.6. Viewing Comments</A
></H1
><P
>        From the "View Topic" page (see <A
HREF="x504.html#VIEW-TOPIC"
>Section 3.5.1</A
>),
        the "Topic Comments" tab can be clicked to 
        view the comments associated
        with a topic.  This can be clicked at any stage to see what
        comments have been submitted against a review.  It is often
        necessary for the author once a review has been completed, to
        work their way through the comments from the browser, although
        they can do this with their email client as well (assuming
        <CODE
CLASS="VARNAME"
>$allow_comment_email</CODE
> is true in
        <TT
CLASS="FILENAME"
>codestriker.conf</TT
>), since each comment
        will generate an email message.  An example screenshot of the
        "Topic Comments" page can be seen in <A
HREF="x602.html#FIGURE-VIEWCOMMENTS"
>Figure 3-10</A
>.
        <DIV
CLASS="FIGURE"
><A
NAME="FIGURE-VIEWCOMMENTS"
></A
><P
><B
>Figure 3-10. Topic Comments Screenshot</B
></P
><DIV
CLASS="MEDIAOBJECT"
><P
><IMG
SRC="viewcomments.png"></P
></DIV
></DIV
>
      </P
><P
>        A separate heading is shown in the display, for each comment
        thread, which represents a series of comments made against a
        specific code line.  For each thread, all of the comments made
        are shown, including author and date information.  For each
        comment thread, the current values of the comment metrics
        associated with the thread will be displayed.  In this
        example, there is only a single comment metric clled "Status".
        The metric values associated with the thread can be updated by
        changing the value of the metric dropdowns, and clicking the
        "Update" button at the bottom of the page.
      </P
><P
>       For each comment thread, there are three links to other
        Codestriker screens.  The first link will bring up a "View
        File" page (see <A
HREF="x504.html#VIEW-FILE"
>Section 3.5.3</A
>) centered on the
        line number of the comment, "Parallel" will do the same, by
        using the parallel view, and the "Add comment" link will bring
        up the "Add Comment" window (see <A
HREF="x504.html#ADD-COMMENT"
>Section 3.5.2</A
>)
        for that line number.
      </P
><P
>        In this particular example, there are two comment blocks, for
        file <TT
CLASS="FILENAME"
>codestriker/codestriker.pl</TT
>, on lines
        27 and 60.
      </P
><P
>        At the top of this page are a number of filtering options,
        which control what comments are displayed.  Comments can be
        filtered by the author of the comment and/or specific comment
        metric values.  In addition, for each comment block, it is also
        possible to display the context of the topic text the comment
        block is made against (as is done for the "Add Comment" page,
        see
        <A
HREF="x504.html#ADD-COMMENT"
>Section 3.5.2</A
>).  These controls provide the
        capability for generating code review reports, which can then
        be used at code inspection meetings.
      </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="x504.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x624.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Reviewing Topics</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="c333.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Topic Properties</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>