C++ Coding Standard Specification - CERN

C++ Coding Standard
Specification
4 Style Version/Issue: 1.1/5
SC3
In the header file, provide a comment describing the use of a declared function and attributes, if
this is not completely obvious from its name.
Example:
class Point {
public:
// Perpendicular distance of Point from Line
Number distance (Line);
}
the comment includes the fact that it is the perpendicular distance.
Source
Status
CXX-10
Common
SC4
In the implementation file, above each method implementation, provide a comment describing
what the method does, how it does it (if not obvious), preconditions and postconditions.
The code in a method will be much easier to understand and maintain if it is well explained in
an initial comment.
SC5
All #else and #endif directives should carry a comment that tells what the corresponding #if
was about if the conditional section is longer than five lines.
The number five is obviously a reasonable arbitrary convention, in order to make the item
objective and checkable.
Example:
#ifndef GEOMETRY_POINT_H
#define GEOMETRY_POINT_H
class Point {
public:
Point(Number x, Number y);
// Create from (x,y)
Number distance(Point point) const; // Distance to a point
Number distance(const Line & line) const; // Distance from a line
void translate(const Vector & vector); // Shift a point
};
#endif // GEOMETRY_POINT_H
Source
Status
CXX-60, R49
Common
page 38
FINAL