| Version 1.9 Build 1556
|
|
Next: Test Programs
Up: Code Review Process
Previous: For the Programmer
Your job is a difficult one and requires a lot of time and effort.
It may also require imagination and diplomacy. Imagination is
needed because you must cultivate the perspective of the non-expert
client programmer, intentionally forgetting things that you know, and
scrutinizing the code (the class header in particular) to make sure
that it explains everything the client programmer will need to know.
You must also be able to take on the domain expert's point of view,
and carefully examine the new class for the quality of its overall
design. You may need considerable diplomacy to persuade a
recalcitrant author that they need to make changes in their code and
documentation.
Your responsibililites include these specific actions:
- Let the cop and the author know how long it will take to
make the first review of the code, and how well you are
sticking to that schedule as the time goes by.
- All email between you and the author which is related to the
new class should be CC'd to the code cop.
- Be prepared for the cop to suggest changes beyond those you
require.
- Base most of your evaluation on the header file for each
class. A quick reading of the implementation file
will allow you to judge the adequacy of its documentation,
and detect any troubling features.
Next: Test Programs
Up: Code Review Process
Previous: For the Programmer
  Contents
  Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc.,
Washington, D.C.
Return to AIPS++ Home Page
2006-10-15