Difference between revisions of "Cpp Coding Standards"
From Apache OpenOffice Wiki
m |
m (→Purpose: Typo fixed.) |
||
| (17 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
=== Purpose === | === Purpose === | ||
| − | [[Coding | + | [[Coding Standards]] are a part of [[defect prevention]]. They gather rules, advice and best practices for developing software, especially the code writing part. Here are listed some ideas what such standards could be for developing with C++ and within the [[OpenOffice.org]] project. |
=== Standards and Reviews === | === Standards and Reviews === | ||
Coding standards and reviews are related. Reviews help getting to know standards and bringing them into the real life of the code. Reviews also help to improve standards and disclose needed changes. | Coding standards and reviews are related. Reviews help getting to know standards and bringing them into the real life of the code. Reviews also help to improve standards and disclose needed changes. | ||
| − | The standards are parted into topics. Each topic is intended to cover an area that is small enough to be the focus of a code review session. The summary of rules regarding one topic should not cover more than "one page" of paper or on screen. This way one topic's summary can be printed out and be used as checklist when studying code. | + | The standards are parted into topics. Each topic is intended to cover an area that is small enough to be the focus of a code review session. The summary of rules regarding one topic should not cover more than "one page" of paper or on screen. This way one topic's summary can be printed out and be used as checklist when studying code. |
| + | |||
| + | To print a summary page out of this wiki such that it fits on one page indeed, select the text of the rule summaries (all text below the content table) and print using the option "print selection". | ||
Most times a summary alone is not enough to understand and discuss a rule, also there are exceptions and hints for realization. So, for each rule there will be a separate wiki page to discuss it. | Most times a summary alone is not enough to understand and discuss a rule, also there are exceptions and hints for realization. So, for each rule there will be a separate wiki page to discuss it. | ||
=== Identifying Rules === | === Identifying Rules === | ||
| − | + | Every topic and each item have an id. | |
| − | Example: [[/FDESIGN#OneTask | FDESIGN:OneTask]] is the rule with the id | + | Ids enable to make notes about rules (e.g. during reviews) and help when talking about them. The ids are not just cardinal numbers, but strings, because strings do not change, when other items are added or removed. |
| + | |||
| + | Example: [[/FDESIGN#OneTask | FDESIGN:OneTask]] is the rule with the id ''OneTask'' which belongs to the topic [[/FDESIGN|Function Design]] with the id ''FDESIGN''. | ||
---- | ---- | ||
| Line 23: | Line 23: | ||
''Topics may appear at multiple domains.'' | ''Topics may appear at multiple domains.'' | ||
| − | ==== | + | ==== Design ==== |
| − | * [[/ | + | * [[/DESIGN|Design]] (DESIGN) |
| − | * [[/ | + | * [[/VIRTUAL|Virtual Classes]] (VIRTUAL) |
| − | * [[/ | + | * [[/CLSDESIGN|Class Design]] (CLSDESIGN) |
| − | * [[/ | + | * [[/IFC|Interfaces]] (IFC) |
| − | * [[/ | + | * [[/FDESIGN|Function Design]] (FDESIGN) |
==== Classes ==== | ==== Classes ==== | ||
| − | * [[/ | + | * [[/CLSDESIGN|Class Design]] (CLSDESIGN) |
| − | * [[/ | + | * [[/VIRTUAL|Virtual Classes]] (VIRTUAL) |
| − | * [[/ | + | * [[/IFC|Interfaces]] (IFC) |
| − | * [[/ | + | * [[/ENC|Encapsulation]] (ENC) |
| − | * [[/ | + | * [[/CLSINIT|Class Construction, Destruction and Copying]] (CLSINIT) |
| − | * [[/ | + | * [[/FDESIGN|Function Design]] (FDESIGN) |
==== Functions and Implementation Generally ==== | ==== Functions and Implementation Generally ==== | ||
| − | * [[/ | + | * [[/GEN|General Coding]] (GEN) |
| − | * [[/ | + | * [[/FDESIGN|Function Design]] (FDESIGN) |
| − | * [[/ | + | * [[/FIMPL|Function Implementation]] (FIMPL) |
| − | * [[/ | + | * [[/ERR|Error Handling]] (ERR) |
| − | * [[/ | + | * [[/SECURITY|Security]] (SECURITY) |
==== Preferred vs. Discarded Types and Habits ==== | ==== Preferred vs. Discarded Types and Habits ==== | ||
* [[/STL|The C++ Standard Template Library]] (STL) | * [[/STL|The C++ Standard Template Library]] (STL) | ||
| − | * [[/ | + | * [[/TYPE|Type Safety]] (TYPE) |
| − | * [[/ | + | * [[/OBSOLETE|Obsolete Habits]] (OBSOLETE) |
==== Files, Formatting, Documentation ==== | ==== Files, Formatting, Documentation ==== | ||
| − | * [[/ | + | * [[/CODEDOC|Code Documentation]] (CODEDOC) |
| − | * [[/ | + | * [[/HEADERS|Header Files]] (HEADERS) |
| − | * [[/ | + | * [[/FORMAT|Code Format]] (FORMAT) |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
---- | ---- | ||
=== Topics in Alphabetical Order === | === Topics in Alphabetical Order === | ||
| − | * [[/ | + | * [[/CLSINIT|Class Construction, Destruction and Copying]] (CLSINIT) |
| − | * [[/ | + | * [[/CLSDESIGN|Class Design]] (CLSDESIGN) |
| − | * [[/ | + | * [[/CODEDOC|Code Documentation]] (CODEDOC) |
| − | * [[/ | + | * [[/FORMAT|Code Format]] (FORMAT) |
| − | * [[/ | + | * [[/DESIGN|Design]] (DESIGN) |
| − | * [[/ | + | * [[/ENC|Encapsulation]] (ENC) |
| − | + | * [[/ERR|Error Handling]] (ERR) | |
| − | * [[/ | + | * [[/FDESIGN|Function Design]] (FDESIGN) |
| − | * [[/ | + | * [[/FIMPL|Function Implementation]] (FIMPL) |
| − | * [[/ | + | * [[/GEN|General Coding]] (GEN) |
| − | * [[/ | + | * [[/HEADERS|Header Files]] (HEADERS) |
| − | * [[/ | + | * [[/IFC|Interfaces]] (IFC) |
| − | * [[/ | + | * [[/OBSOLETE|Obsolete Habits]] (OBSOLETE) |
| − | * [[/ | + | * [[/SECURITY|Security]] (SECURITY) |
| − | * [[/ | + | |
| − | + | ||
* [[/STL|The C++ Standard Template Library]] (STL) | * [[/STL|The C++ Standard Template Library]] (STL) | ||
| − | * [[/ | + | * [[/TYPE|Type Safety]] (TYPE) |
| − | * [[/ | + | * [[/VIRTUAL|Virtual Classes]] (VIRTUAL) |
| + | ---- | ||
| + | |||
| + | === Guidelines === | ||
| + | ''Not easily checkable or not code related.'' | ||
| + | |||
| + | * [[/Principles|Principles]] (PRINC) | ||
| + | * [[/Development Process|Development Process]] (PROCESS) | ||
| + | * [[/Advice|Advice]] - (ADVICE) | ||
| + | |||
---- | ---- | ||
[[Category:Coding Standards]] | [[Category:Coding Standards]] | ||
Latest revision as of 09:31, 14 June 2007
Contents
Purpose
Coding Standards are a part of defect prevention. They gather rules, advice and best practices for developing software, especially the code writing part. Here are listed some ideas what such standards could be for developing with C++ and within the OpenOffice.org project.
Standards and Reviews
Coding standards and reviews are related. Reviews help getting to know standards and bringing them into the real life of the code. Reviews also help to improve standards and disclose needed changes.
The standards are parted into topics. Each topic is intended to cover an area that is small enough to be the focus of a code review session. The summary of rules regarding one topic should not cover more than "one page" of paper or on screen. This way one topic's summary can be printed out and be used as checklist when studying code.
To print a summary page out of this wiki such that it fits on one page indeed, select the text of the rule summaries (all text below the content table) and print using the option "print selection".
Most times a summary alone is not enough to understand and discuss a rule, also there are exceptions and hints for realization. So, for each rule there will be a separate wiki page to discuss it.
Identifying Rules
Every topic and each item have an id.
Ids enable to make notes about rules (e.g. during reviews) and help when talking about them. The ids are not just cardinal numbers, but strings, because strings do not change, when other items are added or removed.
Example: FDESIGN:OneTask is the rule with the id OneTask which belongs to the topic Function Design with the id FDESIGN.
Topics by Problem Domain
Topics may appear at multiple domains.
Design
- Design (DESIGN)
- Virtual Classes (VIRTUAL)
- Class Design (CLSDESIGN)
- Interfaces (IFC)
- Function Design (FDESIGN)
Classes
- Class Design (CLSDESIGN)
- Virtual Classes (VIRTUAL)
- Interfaces (IFC)
- Encapsulation (ENC)
- Class Construction, Destruction and Copying (CLSINIT)
- Function Design (FDESIGN)
Functions and Implementation Generally
- General Coding (GEN)
- Function Design (FDESIGN)
- Function Implementation (FIMPL)
- Error Handling (ERR)
- Security (SECURITY)
Preferred vs. Discarded Types and Habits
- The C++ Standard Template Library (STL)
- Type Safety (TYPE)
- Obsolete Habits (OBSOLETE)
Files, Formatting, Documentation
- Code Documentation (CODEDOC)
- Header Files (HEADERS)
- Code Format (FORMAT)
Topics in Alphabetical Order
- Class Construction, Destruction and Copying (CLSINIT)
- Class Design (CLSDESIGN)
- Code Documentation (CODEDOC)
- Code Format (FORMAT)
- Design (DESIGN)
- Encapsulation (ENC)
- Error Handling (ERR)
- Function Design (FDESIGN)
- Function Implementation (FIMPL)
- General Coding (GEN)
- Header Files (HEADERS)
- Interfaces (IFC)
- Obsolete Habits (OBSOLETE)
- Security (SECURITY)
- The C++ Standard Template Library (STL)
- Type Safety (TYPE)
- Virtual Classes (VIRTUAL)
Guidelines
Not easily checkable or not code related.
- Principles (PRINC)
- Development Process (PROCESS)
- Advice - (ADVICE)
