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

举报
Linux猿 发表于 2021/08/04 23:54:38 2021/08/04
【摘要】     在写代码的时候,通常需要遵循一定的代码格式规范,本文针对自己做项目以及所接触的代码形式,同时也参考红帽rpm源码和谷歌代码规范,总结一下写代码时的编程规范,当然这不是硬性规定,许多地方可以根据自己的喜好进行选择。规范更多的是为了让别人能够快速看懂你写的代码,不用在代码形式上浪费时间,同时也使代码更简洁易懂。 一、为什么编写代码要有规范? 能够让...

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

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

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

二、变量命名原则

(1)普通变量

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

例如:


  
  1. int flag;
  2. int interfaceFlag;
  3. int installInterfaceFlag;

(2)枚举变量

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

例如:


  
  1. FLAG_BANANA
  2. FLAG_APPLE
  3. FLAG_ORIGNE
  4. STUDENTFLAG_INFORMATION
  5. STUDENTFLAG_TECNORLEGE

(3)全局变量

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

例如:


  
  1. int  gStudentInformation = 10;
  2. int gTeacherInformation = 20;

(4)常量

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

例如:


  
  1. const int kStudentInformation = 100;
  2. const int kTeacherInformation = 200;

三、循环/条件语句规则

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

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

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

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

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

例如:


  
  1. // <i> 代表此处有几个空格
  2. if<1>(flag)<1>{
  3. <4>……
  4. }<1>else<1>{
  5. <4>……
  6. }// 单独占据一行,与if在同一列
  7. while<1>(flag)<1>{
  8. <4>……
  9. }
  10. for<1>(i = 0; i < n; ++i)<1>{ // 其中,i<1>=<1>0等,这里不再标明;
  11. <4>……
  12. }
  13. switch<1>(flag)<1>{
  14. case 1: // 与switch在同一列
  15. <4>……
  16. <4>break;
  17. case 2:
  18. <4>……
  19. <4>break;
  20. default:
  21. <4>……
  22. }

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

 

文章来源: blog.csdn.net,作者:Linux猿,版权归原作者所有,如需转载,请联系作者。

原文链接:blog.csdn.net/nyist_zxp/article/details/106416129

【版权声明】本文为华为云社区用户转载文章,如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。