Cpp Coding Standards/IFC
Topic-Id: IFC
The public functions of a class are in interface, but these items refer also to any other kind of interface. They are especially important for classes or functions that are expected to be used by possibly yet unknown clients.
Contents
Summary
Consistency (Consi)
Give the same thing the same name everywhere in the interface.
Let parameters with the same semantic always occur in the same order in different functions.
Minimality (Min)
Provide only one way to do anything. Move functions that do not belong to the core functionality of the interface to more appropriate locations.
For classes: Put convenience functions as non-member functions in the same namespace beside the class.
Unambiguous Overloads (Over)
Let all overloads of a function be unambiguous. Be aware of default arguments and integral vs. pointer parameters. Provide either only one version of an integral type or (rarely) overloads for all C++ integer-types.
Related Rules
- CLSDESIGN:OneResp - OneResponsibility
