Difference between revisions of "Cpp Coding Standards/FDESIGN"
From Apache OpenOffice Wiki
m (Cpp Coding Standards/Topics/FDESIGN moved to Cpp Coding Standards/Function Design: Improve Cpp_Coding_Standards structure.) |
|||
| Line 1: | Line 1: | ||
| − | + | Topic-Id: '''FDESIGN''' | |
| − | Design of functions and function prototypes. Items referring to code in function bodies, reside in [[../FIMPL | FIMPL]] | + | Design of functions and function prototypes. Items referring to code in function bodies, reside in [[../FIMPL |FIMPL]] - Function Implementation. |
| + | |||
---- | ---- | ||
=== Summary === | === Summary === | ||
| − | ==== OneTask ==== | + | ==== One Task <span id="OneTask">(OneTask)</span> ==== |
Give one function only one cohesive task. | Give one function only one cohesive task. | ||
| − | ==== | + | [[/OneTask|Details]] |
| + | |||
| + | ==== Canonical Operators <span id="CanOp">(CanOp)</span> ==== | ||
Use canonical signatures for all operator overloads. Provide canonical behavior for arithmetic operators. | Use canonical signatures for all operator overloads. Provide canonical behavior for arithmetic operators. | ||
| − | ==== | + | [[/CanOp|Details]] |
| + | |||
| + | ==== Unambiguous Parameter <span id="Params">(Params)</span> ==== | ||
Mark parameter intention unambiguously. Out- and inout- parameters need to be distinguished unmistakably. | Mark parameter intention unambiguously. Out- and inout- parameters need to be distinguished unmistakably. | ||
Use smart pointers as parameter type for objects on the heap, when the responsibility for deleting is unclear or transfered between caller and callee. | Use smart pointers as parameter type for objects on the heap, when the responsibility for deleting is unclear or transfered between caller and callee. | ||
| + | |||
| + | [[/Params|Details]] | ||
| + | |||
---- | ---- | ||
=== Related Rules === | === Related Rules === | ||
| − | * [[../ | + | * [[../Function Implementation#Short | FIMPL:Short]] - Short Functions |
| − | * [[../ | + | * [[../Interfaces#Consi |IFC:Consi]] - Consistency |
| − | * [[../ | + | * [[../Interfaces#Over |IFC:Over]] - Unambiguous Overloads |
| − | - | + | |
| − | + | ||
---- | ---- | ||
[[Category:Coding Standards]] | [[Category:Coding Standards]] | ||
Revision as of 22:10, 29 November 2006
Topic-Id: FDESIGN Design of functions and function prototypes. Items referring to code in function bodies, reside in FIMPL - Function Implementation.
Contents
Summary
One Task (OneTask)
Give one function only one cohesive task.
Canonical Operators (CanOp)
Use canonical signatures for all operator overloads. Provide canonical behavior for arithmetic operators.
Unambiguous Parameter (Params)
Mark parameter intention unambiguously. Out- and inout- parameters need to be distinguished unmistakably.
Use smart pointers as parameter type for objects on the heap, when the responsibility for deleting is unclear or transfered between caller and callee.
Related Rules
- FIMPL:Short - Short Functions
- IFC:Consi - Consistency
- IFC:Over - Unambiguous Overloads
