- ... file,1
- See
code/install/codedevl/template-class-h
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... file,2
- See code/install/codedevl/template-class-cc. Neither totally inlined
classes, nor abstract base classes may need an implementation file.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ...
program3
- See code/install/codedevl/template-main-cc
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... classes4
- A
good example is a read-only class, and a read-write class derived from it.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ...
files.5
- If you do this, make sure that the documentation sections -
synopsis, etymology, motivation, etc. - are completed for every
class contained in the file.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... file.6
- Special language tools can measure coverage. See AIPS++ Note 170,
``The AIPS++ Code Review Process'' for suggestions on writing test programs.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... declarations7
- Explicitly or implicitly like in
iosfwd or Complexfwd
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... types8
- Char, uChar, Int, uInt, Float, Double, lDouble, Complex, DComplex,
String. In special circumstances the use of Long and uLong is allowed.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... directory.9
- See code/install/codedevl/template-module-h. The Tables module,
code/aips/implement/Tables is a good example to study.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ...
used.10
- As a rule, it is advisable for application programmers to
include in their code the include files for the individual classes being
used.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... file11
- See
code/install/codedevl/template-module-h
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ...
management.12
- reident, unused, duplicates programs
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... updated.13
- See, for instance, the
documentation tags reviewed and todo in template-class-h.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... suffice.14
- This may sometimes
involve the use of special forwarding include files like iosfwd.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... it.15
- Or
declare the references and pointers const - but be aware of threading
problems in that case
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ...
constructor16
- Note that this is only created when
no user constructor at all present
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ...
destructor17
- always supply a virtual destructor in a base class
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... last.18
- This order may seem unnatural, but it is a
direct consequence of the C++ rule that default parameters appear
last in the parameter list.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... argument.19
- But also consider strcpy from the
standard C library, which both modifies an argument, and returns
that same value as the function return value.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ...
definition.20
- In the case of a
``placeholder'' parameter that is not yet used in the definition, omit the
name in the definition to stop warnings.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
- ... types.21
- A good example can
be found in the MeasConvert class
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.