Difference between revisions of "Cpp Coding Standards/IFC"
m (Cpp Coding Standards/Topics/IFC moved to Cpp Coding Standards/Interfaces: Improve Cpp_Coding_Standards structure.) |
|||
| Line 1: | Line 1: | ||
| − | + | 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. | 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. | ||
---- | ---- | ||
=== Summary === | === Summary === | ||
| − | ==== Consistency ==== | + | ==== Consistency <span id="Consi">(Consi)</span> ==== |
Give the same thing the same name everywhere in the interface. | 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. | Let parameters with the same semantic always occur in the same order in different functions. | ||
| − | ==== Minimality ==== | + | [[/Consi|Details]] |
| + | |||
| + | ==== Minimality <span id="Min">(Min)</span> ==== | ||
Provide only one way to do anything. Move functions that do not belong to the core functionality of the interface to more appropriate locations. | 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. | For classes: Put convenience functions as non-member functions in the same namespace beside the class. | ||
| − | ==== | + | [[/Min|Details]] |
| + | |||
| + | ==== Unambiguous Overloads <span id="Over">(Over)</span> ==== | ||
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. | 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. | ||
| + | |||
| + | [[/Over|Details]] | ||
---- | ---- | ||
=== Related Rules === | === Related Rules === | ||
| − | * [[../ | + | * [[../Class Design#OneResp |CLSDESIGN:OneResp]] - OneResponsibility |
| − | - | + | |
| − | + | ||
---- | ---- | ||
[[Category:Coding Standards]] | [[Category:Coding Standards]] | ||
Revision as of 22:31, 29 November 2006
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
