Coding Standard

From Toysoldiers

Template:Expansion

For the sake of consistency and easier to understand code, we will follow the GNU Coding Standard.

Contents 1 Names 1.1 Variables 1.2 Functions 1.3 Types 1.4 C++ Namespaces and Java packages 1.5 Macros 1.6 Source Files 2 Self-Documenting Code 2.1 Simplicity 2.2 Meaningful Names 2.3 Atomic Functions 2.4 Descriptive Types 2.5 Name Constants 2.6 Emphasise Important Code 2.7 Group Related Information 2.8 Provide a File Header 2.9 Handle Errors Appropriately 2.10 Write Meaningful Comments 3 Literate Programming 3.1 Documentation Tools 4 Consistency 4.1 Fixed tab lengths 4.2 Braces 4.3 Language Usage

Names

Variables

Functions

Types

C++ Namespaces and Java packages

Macros

Source Files

Self-Documenting Code

Simplicity

Meaningful Names

Atomic Functions

Descriptive Types

Name Constants

Emphasise Important Code

Group Related Information

Provide a File Header

Handle Errors Appropriately

Write Meaningful Comments

Literate Programming

Documentation Tools

Consistency

Fixed tab lengths

Braces

Language Usage

The above tips are taken from Pete Goodliffe's Code Craft: The Practice of Writing Excellent Code.