Cpp Coding Standards/FDESIGN
From Apache OpenOffice Wiki
Contents
Function Design (FDESIGN) - Summary
Design of functions and function prototypes.
Items referring to code in function bodies, reside in topic FIMPL - Function Implementation.
One Task (OneTask)
Give a function only one cohesive task. -> Details
Canonical Operators (CanOp)
Use canonical signatures for all operator overloads. Provide canonical behavior for arithmetic operators. -> Details
Unambiguous Parameters (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. -> Details
Related Rules
- FIMPL:Short - Short Functions
- IFC:Consi - Consistency
- IFC:Over - Unambiguous Overloads