c++ program specification

2023-04-20

命名风格

命名风格有很多种,常见的有大驼峰,小驼峰,蛇形
大驼峰:每个单词首字母大写,其余小写,例如 FunTest
小驼峰:第一个单词首字母小写,其余单词首字母大写,例如 funTest
蛇形: 所有单词字母都小写,但是单词间有下划线,例如 fun_test

使用统一的命名风格

一般建议,类的名称、函数名称使用大驼峰;函数参数、局部变量、类成员变量使用小驼峰;全局变量g_前缀+小驼峰

一些约定俗成的规范

  1. 命名时,应该使用英文单词,不是中文拼音。
  2. 应该使用行业内存在的术语缩写,不要自创缩写。

文件命名

源文件一般以.cpp结尾,头文件一般以.h结尾
文件命名时,一般与文件中存在的类的名称一致。
比如: 文件中存在 TestSpeed类,那么文件名称可以是:TestSpeed.h TestSpeed.cpp;也可以是 test_speed.h test_speed.cpp

注释

首先需要注意的是合理使用注释,不要冗余注释,要添加有效注释

注释格式

  1. 注释符和注释内容之间应该存在一个空格
  2. 注释应该位于代码的上方或右方

格式

函数大括号统一风格

K&R,1TBS,Allman风格。
有如下几个规范:

// K&R 风格
void CheckPositive(int x)
{
    if(x>0){
        printf("true");
    }else{
        printf("false");
    }
}

// 1TBS风格
void CheckPositive(int x){
    if(x>0){
        printf("true");
    }else{
        printf("false");
    }
}

// Allman风格
void CheckPositive(int x)
{
    if(x>0)
    {
        printf("true");
    }else
    {
        printf("false");
    }
}

注意统一规范即可。

行宽上限不超过120

注意行宽。