GEANT4 Project Members
S. Ravndal
Proposed coding conventions
In the following I would like to propose a set of coding rules and standards for the GEANT4 project. This coding rules do not claim to be complete, but are a selected collection from the proposal of other projects or are have been obtained to be reasonable in rather big and new software projects.
Table of contents:
- The C++ Standard
-
- Source file conventions
-
- Comments
-
- Filenames
-
- Classes
-
-
-
- Names
-
- Abbreviations
-
- Constructors and operators
-
-
-
-
-
-
-
-
-
-
-
- Allocation routines
-
- Class definition conventions
-
- Data Access Rights
-
- Arguments and function results
-
- Compound Statements
-
- Flow Control Structures
-
- Error/Exception handling
-
- Portability issues
-
- Do's
-
- More don'ts
-
- Summary
-
- Literature
-
- Example of a class header file
-
- Example of a class implementation file
-
ravndal@cernvm.cern.ch - 30 MAR 95
Generated with CERN WebMaker