C/C++代码格式规范(一)

    在写代码的时候,通常需要遵循一定的代码格式规范,本文针对自己做项目以及所接触的代码形式,同时也参考红帽rpm源码和谷歌代码规范,总结一下写代码时的编程规范,当然这不是硬性规定,许多地方可以根据自己的喜好进行选择。规范更多的是为了让别人能够快速看懂你写的代码,不用在代码形式上浪费时间,同时也使代码更简洁易懂。

一、为什么编写代码要有规范?

  • 能够让代码简洁易懂;
  • 能够让同一项目的人快速理解;
  • 好看美观 ^_^;
  • 同一项目中使用相同的规范,能让代码统一,能快速理解代码;
  • 变量命名不再纠结,哈哈哈!

二、变量命名原则

(1)普通变量

  • 变量开头字母使用小写;
  • 变量尽量使用英文单词名词;
  • 多个名词直接相连(驼峰式)或使用"_"相连(下划线式);
  • 多个名词直接相连时,除第一个名词外,其它名词首字母大写,以便区分单词;
  • 单词尽量使用全拼,不要省略,比如install 写成ins或inst,简写不好理解;

例如:

int flag;
int interfaceFlag;
int installInterfaceFlag;

(2)枚举变量

  • 字母全部大写;
  • 单词之间或多个单词之间使用下划线连接“_”;
  • 同一类使用相同的前缀(比下面例子中的:FLAG,STUDENTFLAG);

例如:

FLAG_BANANA
FLAG_APPLE
FLAG_ORIGNE
STUDENTFLAG_INFORMATION
STUDENTFLAG_TECNORLEGE

(3)全局变量

  • 全局变量以g开头,其它遵循普通变量规则;
  • 尽量不用全局变量;

例如:

int  gStudentInformation = 10;
int  gTeacherInformation = 20;

(4)常量

  • 常量以k开头,其它遵循普通变量规则;

例如:

const int kStudentInformation = 100;
const int kTeacherInformation = 200;

三、循环/条件语句规则

(1)左圆括号和关键字之间有一个空格;

(2)右圆括号和左大括号之间有一个空格;

(3)圆括号和表达式/变量之间没有空格;

(4)左圆括号不单独占据一行;

(5)右圆括号单独占据一行;

例如:

//  代表此处有几个空格
if<1>(flag)<1>{
<4>……
}<1>else<1>{
<4>……
}// 单独占据一行,与if在同一列

while<1>(flag)<1>{
<4>……
}

for<1>(i = 0; i < n; ++i)<1>{ // 其中,i<1>=<1>0等,这里不再标明;
<4>……
}

switch<1>(flag)<1>{
case 1: // 与switch在同一列
<4>……
<4>break;    
case 2:
<4>……
<4>break;
default:
<4>……
} 

    今天先总结这些,后续会继续补充,敬请期待!大家如果有不同的理解可以一块探讨呀!

 

你可能感兴趣的:(Linux,&,安全)