C++代码书写规范简介

编码规范并不是必须的,写代码遵守一定的规范,会使阅读代码修改bug轻松一些。

作为代码初学者,了解掌握最基本的代码书写规范知识是必要的。由于代码不仅仅是让程序执行,代码更是给人看的,层次分明清晰的代码和必要的注释的代码可读性更好,能够避免一些BUG或者更容易令人审查识别出BUG,为未来写大的程序和团队合作养成习惯打下基础。

这是个比较大的主题,细节很多,需要多借鉴多练习,不断地领悟。在此仅介绍基本的代码书写规范。特别提示,不同的团队的约定不尽相同。

1、空格

建议1:函数名之后不要留空格,紧跟左括号‘ (’,以与关键字区别。如:int Fun1(int x)

建议2:象 if、 for、 while等关键字之后应留一个空格再跟左括号‘ (’,以突出关键字。如: if (i = 0)

建议3:定义变量的逗号之后要留空格。在for语句中的分号其后要留空格。如:

int a, b;

for (i=0; i<5; i++)

建议4:赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“ =”、“ +=” “>=”、“ <=”、“ +”、“-”、“*”、“ %”(求余运算符)、 “ &&”、“ <<”、 “ ^”等二元操作符的前后应当加空格。如: a = b; a += 10;

建议5:一元操作符如“ !”、“ ~”、“ ++”、“-”(负号运算符)、“*”(指针运算符) “ &”(地址运算符)等前后不加空格。

【顺便提示:操作符也称为运算符,有些操作符有两种作用,如:

“-”,作为单目操作符“-”是负数操作符,作为算术操作符“-”是减法操作符。

“*”,作为单目操作符“*”是指针操作符,作为算术操作符“*”是乘法操作符。】

2、空行

建议1:在实现函数时,函数与函数之间应加空行。如:

void Fun1(int x)
{
  //do something
}
 
void Fun2(double y)
{
  //do something
}

建议2:在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行。

3、变量名、函数名

建议1:变量,函数,文件命名最好采用英文单词或词组,不要使用拼音,或者无意义的a b c之类的,用有意义的英文单词或其缩写命名能起到在缺少注释的情况下能够给阅读者起提示作用。

名规则:以大小驼峰式命名法为主,小写字母加下划线为辅

小驼峰法:第一个单字以小写字母开始,第二个单字的首字母大写。例如:firstName、lastName。

大驼峰法:每一个单字的首字母都采用大写字母,例如:FirstName、LastName、CamelCase。

建议2:类名和函数名用大写字母开头能和普通变量区分开。如:

class ReadBook;

void DrawImage();

建议3:变量和参数用小写字母开头的单词组合而成。如:

int value;

void SetValueMode(int valueMode);

建议4:常量全用大写的字母,用下划线分割单词。如:

const int MAX = 100;

const int MAX_LENGTH = 100;

4、注释

C++中注释主要有两种,程序块的注释常采用“ /*…*/”,行注释一般采用“ //…”。注释主要用在3个地方。1、版权申明,2、函数说明,3、重要或复杂代码提示。

有时候读代码会跟不上编程者的思维,若代码旁边没有注释,就难以理解其意思,因此适当添加注释不仅能够让自己回忆某行、某段代码的用处,还能方面阅读者理解。建议边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要记得删除。

5、缩进

我们看到上面代码中输出语句和return 0;语句前面都有四个空格,这就是缩进。在必要的地方加入缩进,一般是{ }之间加入缩进,可以使代码更加清晰。

缩进一般是一个制表符(即键盘上的Tab键)或者四个空格,而小古银的习惯是制表符,由于网站会将制表符转换成四个空格,所以你看到的代码都是四个空格的。如:

int main()
{
    if (…)
    {
        while (…)
    }
    return 0;
}

附:

google编程规范(中文)https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/

google编程规范(英文)https://github.com/google/styleguide

C++代码书写规范简介相关推荐

  1. c#书写规范之---代码书写规范

    代码书写规范          格式化使代码的逻辑结构很明显.花时间确保源代码以一致的逻辑方式进行格式化,这对于您和你的开发小组,以及以后维护源代码的其他开发人员都有很大的帮助. 以下几点是推荐的格式 ...

  2. java 代码书写规范_代码书写规范和命名规范

    上一篇给大家分享了一下,关于文档编写的几个概念.这篇文章阐述如果编写代码书写规范以及命名规范文档.[以java语言为例] 1.代码书写规范 代码书写规范,能够让不同的人,写出相同风格的代码.很多人都看 ...

  3. GNU的C++代码书写规范,C语言之父Dennis Ritchie亲自修订 (转)

    GNU的C++代码书写规范,C语言之父Dennis Ritchie亲自修订 (转)[@more@]C++ Standard Library Style Guidelines  DRAFT 1999-0 ...

  4. GNU的C++代码书写规范

    GNU的C++代码书写规范,C语言之父Dennis Ritchie亲自修订 C++ Standard Library Style Guidelines  DRAFT 1999-02-26 ------ ...

  5. 网页编程代码书写规范

    网页编程,也就是网页代码的编写,其实也就是编程代码的书写,一个好的网站,其网页编码,是比较规范的,条理清晰,格式简洁美观,可读性强,那到底怎样才能规范好代码的编写规范,是一个值得大家深思的问题,想想自 ...

  6. 天勤考研中数据结构的代码书写规范以及C与C++语言基础

    考研综合应用题中算法设计部分的代码书写规范 头文件 头文件部分如果题目没有特殊说明可以去掉. 常量 如果题目中要用到一个常量,则在用的地方加上一句注释,说明某某常量已定义即可,不必在前面补上#defi ...

  7. WEB前端代码书写规范

    WEB前端代码书写规范 1. 命名规范 a.ClassName命名 ClassName的命名应该尽量精短.明确,必须以单页面字母开头命名,且全部字母为小写,单词之间统一使用下划线 "_&qu ...

  8. 论代码书写规范的重要性——分享一篇良好的代码书写规范,从小白开始培养..(表示太难了吧)

    Web前端开发规范手册 文章目录 一.规范目的 1.1 概述 - 1 二.文件规范 2.1 文件命名规则-1 2.2 文件存放位置-2 2.3 css 书写规范-3 2.4 html书写规范-7 2. ...

  9. Unity项目代码书写规范

    以Google的代码规范为主,稍加改动 https://google.github.io/styleguide/csharp-style.html 书写规范 基础写法 Pascal和驼峰混用,参数用驼 ...

最新文章

  1. easyui validate 后 使用ajax提交
  2. linux下批量修改文件名精彩解答案例分享
  3. c语言 搜索题油田问题,HDU1241 经典油田问题(BFS)
  4. [转]SQL Server 索引基础知识(2)----聚集索引,非聚集索引
  5. 20135213——信息安全系统设计基础第十周学习总结
  6. sort();对结构体数组的排序
  7. PHP实现菱形与杨辉三角形【php趣味案例】
  8. 输入输出知识点和问题超全总结(持续更新中)
  9. fastmock模拟常见数据结构
  10. python编程基础及应用教程答案_Python编程基础教程
  11. php初级入门教程_PHP初学者教程
  12. AirDisk-Q3C/T2/Q3S/Q3X加密空间PIN码忘记怎么找回?
  13. Photoshop CS6 32位64位破解补丁
  14. ext4文件系统错误处理机制
  15. VSFTP一键部署脚本
  16. 基恩士KV8000程序 基恩士KV8000,威伦通触摸屏,搭载KV-XH16EC总线模块进行分布式总线控制
  17. 用meta name=renderer content=webkit|ie-comp|ie-stand来切换360双核安全浏览器的极速模式和兼容模式
  18. 算法笔记04--分治法之寻找最大最小元素
  19. 我自己做了一个小站,刚学做网站。大家帮忙给看看吧!
  20. 静态路由设置实例解析

热门文章

  1. 揭秘华为第二届网络安全沙龙——问道
  2. oracle的前端是什么,Oracle的那些事情
  3. Facebook实现第三方登陆(WEB)并获取用户信息
  4. 什么NAS能实现多平台同步?AirDisk-Q3X/Q2/Q3S微力同步告诉你怎么实现
  5. shell实例100例《七》
  6. 强化学习笔记 - 00 - 术语和数学符号
  7. 自制 Windows 小工具 ———— 智能截屏工具
  8. 使用单片机AT89S52设计一台微型程控搅拌机
  9. 滴滴第一季度共发生111起治安类案件 83%为乘客侵犯司机
  10. 如何用Google Analytics监测百度竞价广告