C++ 代码规范(英文版)

C++ Coding Standards

The Corelinux Consortium - Revision 1.6

Abstract:

This document describes the C++ Coding Standards as they are used in the

corelinux++ project. It provides a set of guidelines, rationales and

standards for C++ coding.

Contents

 Scope

o Keyword Constructs

o Preprocessor

o Spaces

o Wrapping

 Naming Conventions

o Files and Directories

 Usage

o Conditionals

o Loop Constructs

o Data

o Inheritance

o Object-Oriented Considerations

o Error Handling

o Exception Specification

 File Layout

o Header File Layout

 Linux Special Care and Handling

 Bibliography

Copyright notice

which will provide for easier maintenance of code. This will benefit the team

and the project in that those who are new to the code can quickly orient

themselves, and thereby sooner become productive members of the team. It

is intended to be a dynamic document and can be reviewed as needed. It is

recommended that each programmer keep a copy on hand also.

Document Overview

The following document sections contain standards, guidelines, and

rationales. Guidelines must be adhered to unless there is compelling reason

to deviate. Deviation from a guideline must be discussed and approved during

the code walk-through. A standard is an item to which compliance is

mandatory. Deviation from a standard must be discussed, approved, and

been used where necessary to explain the meaning of an item, or why it was

This section deals with the placement and contents of comments in the

code.

Code Layout

This section has to do with the alignment of the code, white space,

declarations and keywords, and where they should all be located.

Naming Conventions

This section contains the structure for naming classes, functions, files,

and directories.

Usage

This section concerns the 'how' and 'when' certain constructs should be

used (for example, loops, inheritance, error handling, etc.)

General Principles

The primary goal of the coding standard is maintainability. Other important

considerations that relate to the spirit of the standard includes correctness,

readability, consistency, extensibility, portability, clarity, and simplicity. When

in doubt, the programmer should strive for clarity first, then efficiency.

Think of the reader. Do not just write for yourself. Keep it simple. Break down

complexity into simpler chunks. Clearly comment necessary complexity. Be

explicit. Avoid implicit or obscure language features. Be consistent. Minimize

scope, both logical and visual.

Comments

Guideline 1: Be clear and concise. Say what is happening and why. Do not

Guideline 2: Keep code and comments visually separate.

{

DECLARE_CLASS( SomeClass );

/**

Main documentation for the class appear after

namespace and any type or

class macros and above the actual class declaration.

Unless of course it is NOT a CoreLinux++ class.

*/

class SomeClass

@return Type modifier @exception

Type [,Type]

*/

-or-

/// Destructor

for members

/// Single line primarily for data members

}

Standard-CPP 1:Use only the C++ comment style (double slashes) for single

line comments.

Guideline 3: For block comment styles either C++ (double slashes) or C

Standard 3:The trailer comment should only include configuration

management information defined as:

/*

Common rcs information do not modify

$Author: frankc $

$Revision: 1.6 $

$Date: 2001/01/01 13:39:18 $

$Locker: $

*/

Guideline 4: Prefer block comments over trailing comments. Use block

comments regularly. Only use trailing comments for special items.

they describe.

Guideline 5: Write code in a series of chunks.

Guideline 6: Use block comments to separate the chunks.

Standard 8: Put one statement per line, except with in-line code in a header

Standard 9: Indentation level is three (3) spaces.

Braces and Parenthesis

Standard 10: Braces shall be aligned using Ulman style where the braces

are at the same scope as the statement that proceeds them and the code

within the braces is indented one level. Braces are always on a line by

themselves.

void doSomething( void )

{

if( x != y )

{

-NOT-