Coding Convention Rules

1. ArrayElementAccess(V) : 确保数组元素通过数组操作符[ ]获取。

2. AvoidEllipses(V):不要使用省略号。可以使用默认参数。

    例如:int foo( int a, ... );// Violation 

               int foo( int a, int b = 0 );// OK

3. AvoidFuncDefinitonInClass: 不要在类定义里定义成员函数. 确保接口和实现分离。函数定义在类定义内是默认inline, 而且不紧凑不利于阅读。

4. AvoidGotoStatement:不要使用goto

5. AvoidInlineConstrDestr:不要把构造函数和析构函数定义为inline。function that invoke other inline function often become too complex for the compiler, and the compiler cannot make them inline.

6. AvoidStructWithMemberFunction:不要定义包含成员函数的struct。 函数应该包含在class内。

7. AvoidTernaryOperator:不要使用三元操作符?: 影响可读性

8. AvoidVoidParameter: 如果函数没有参数,使用()而非(void),声明一致性

9. BreakInForLoop: 不要在for循环内使用break

10. CastFuncPtrToPrimPtr: Do not type cast pointers to primitive types for variables that have

been declared as pointers to functions。

    This rule detects if you type case pointers to primitive types for variables that have been declared as

pointers to functions.

    Benefits:Following this rule helps you make code less error-prone; casting pointers to functions to pointers of

primitive types can result in errors.

Example:

void Foo(char *ptrC)

{

    *ptrC = 0;

    return;

}

void f()

{

    void *ptrV = 0;

    void (*funPtr) (char*) = 0;

    funPtr = &Foo;

    ptrV = (void*)funPtr; // Violation

    return;

}

Output:Pointer to a function is cast to a pointer of primitive type


11. CommaOperator:逗号运动算符仅仅用在变量声明/定义或多语句预处理器宏定义。好处是提高可读性和防止额外的使用逗号操作符

12. ConditionCurlyBraces:所有if 和else statements必须跟随{ },识别与该语句相关的代码。

13. ConditionCurlyBraces2:确保所有条件语句都使用{} 来识别与之相关的代码

14. ConstParam: 尽可能声明引用参数为常量引用。如果函数不打算改变引用的参数, 可以声明为常量引用来避免函数返回值意外修改或防止无意中修改调用者的数据。

15. ConstPointerFunctionCall:如果指针指向不被改变可以传const指针

16. DeclareArrayMagnitude:如果数组作为函数的参数时,不要声明它的大小。单维数组的大小永远不要在参数中声明,多维数组大小不能全部声明大小。因为不同函数调用可能传参不同的大小。

17. DeclDimArray:不要在数组初始化的时候声明它的大小。因为维护性较差。

    #define SIZE 4

    int tab1[SIZE] = {1,2,3}; // Violation

     int tab2[]={1,2,3}; // OK

18. DefaultInSwitch:不要省略switch 的default分支

19. DoWhile:不要使用do while,应该使用while 

20. EnumKeyword: 不要用enum关键字声明一个变量。

    enum Colors { RED, BLUE, GREEN };

    enum Colors c; // Violation

    enum Colors { RED, BLUE, GREEN };

    Colors c; // OK

21. EOSUsage:使用EOS define代替直接使用“\0”作为字符串的终止符。

    #define EOS '\0';

    char str[30] = "Sample text.";

    str[7] = '\0'; // Violation

    str[7] = EOS; // OK

22. ExplicitEnumValues:确保enum的每个成员被明确声明。

    enum my_enum1

    {

        a, // Violation

    };;

    enum my_enum1

    {

        a = 0 // OK

    };;

23. ExplicitLogicalTests:在条件表达式中使用明确的逻辑比较。if (isvisible) // Violation

24. ExplicitlyReturnType:明确函数返回类型,假如没有,编译器会认为是void或int。

    foo( ); // Violation

    int foo( );// OK

25. ExprInSizeof:避免传给表达式给sizeof(),例如赋值语句传给它。

    iVar1 = sizeof(iVar2 = 1); // Violation

26. FalseDefinition:如果FALSE没有定义,那么 Definition FALSE为0

27. FalseTypedef:如果FALSE没有定义,那么typedef FALSE为0 

28. ForLoopVarAssign:从for语句的body中去除循环控制变量的赋值。循环控制变量应该仅被修改在for循环语句的初始化和条件表达式。在for循环内修改它们使得循环条件很难理解和可能出现逻辑缺陷。

29. FuncModifyGlobalVar:避免函数修改global变量

30. GlobalVarFound:避免声明global变量

31. HardCodeValue:使用“#define” 或enum常量代替hard coded values(魔幻数字)

32. HardCodeValueWithZero:

33. IfElseWhileFollowBlock:循环语句即使为空也要加大括号(with block)

34. MacroWithinInclude: 不要在include声明语句中使用宏定义()

    #define HEADER_FILE(nr) "myHeader" #nr ".h"

    #include HEADER_FILE(12) //Violation

35. ModifyInCondition: 不要在if while switch条件表达式中使用++ -- 操作符

36. NullDefinition: 定义NULL “(void*)0”

37. OnlyOneReturn:函数最多有一个return 语句

38. PartialStatementDefinition:不要定义生命的一部分

    #define PARTIAL(a)    ((a) * // Violation

39. PassByValue:

40. RedefControlStatements:不要重新定义循环控制语句if while try

41. RedefPrimitiveTypes: 不要redefine原始数据类型char 

    #define T30 char //Violation

    #define T31 unsigned char // OK

42. RedefTypes:

43. SepareLogicalTests:使用明确的逻辑表达式

44. SingularSwitchStatement:避免switch只有一条case语句,如果这样应该改写成if else。

45.SourceFileSize:避免source file超过500行

46. StructKeyword:不要使用struct关键字来声明一个变量

    Example:

    struct Position_t {};

    struct Position_t Pos; // Violation

    Repair:

    struct Position_t {};

    Position_t Pos; // OK

47. TrueDefinition:如果TRUE需要被定义,那么应该定义为1

48. TrueTypedef:

49. TypeModifiersAfterTypes: Ensure that storage type modifiers are associated with the type, not the variable

    int static i; //Violation

    static char j; //OK

50. UnnecessaryEqual:在bool函数内去掉不必要的==true

    bool foo()

    {

        return isPositive(5) == true; // Violation

        return isPositive(5); // OK

    }

51. UseParenthesisInMacros: 在宏定义表达式中, 应该在乘除号之前和之后加上括号。

    #define MULTI_1(x)    (x * (x)) //Violation

    #define MULTI_3(x)     ((x) * (x)) //OK

52. UsePositiveLogic:使用正逻辑而非赋逻辑

53. UseTypedefForFuncPointers: 函数指针应该typedef

54. StructureTypedef:所有结构体应该有typedefs

    Example

    struct A// Violation - no typedef

    {

        int i;

    };

    Repair

    typedef struct A // OK

    {

        int i;

    } A_t;

    or

    struct A // OK

    {

        int i;

    };

    typedef struct A A_t;

    note:这个rule仅仅是用于c。

55. UsingVoid:void should be used when a function is passed or returns no values。

56. CFilesIncludingCFiles: .c files may not include other .c files。Many build environments are set up to automatically compile every .c file. If in addition a .c file is included in another .c file, this will result in link errors.

57. SelectorOperatorsShouldBeConst:Conversion operator, operator->, operator(), operator[] should be const。 操作符重载应该声明为const。

class A {

public:

    A& operator()( int x ); // Violation

    A& operator[]( int x ); // Violation

    A& operator->( int x ); // Violation

    operator int( ); // Violation

};

Repair

class A {

public:

    A& operator()( int x ) const; // OK

    A& operator[]( int x ) const; // OK

    A& operator->( int x ) const; // OK

    operator int( ) const; // OK

};

60. OperatorsShouldBeConst:Bitwise operators, comparison operators, logical operators, comma operator should be const。 presumes that they do not change the internals of the object they are called on. Therefore, it is a good practice to declare them const.

61. LocalAndMemberNamesDifferByCaseOnly: local 变量/参数 和class/parent class/parent struct 成员变量应该是不同的名字。

62. LocalAndMemberNamesDifferByOneCharOnly:

你可能感兴趣的:(Coding Convention Rules)