前言

 本博主从前觉得代码管理软件质量这种东西从来没有放在心上，自己能把项目做出来，能看懂自己写的代码就好了；直到入职一家公司后，做的第一件事情就是被公司软件经理“ 坤哥 ”安排学习完这篇文档。初次学习这篇文档"高质量C++/ C编程指南 "自己最先的感受是惊慌，我以前捏造的代码程序竟然都是毛病，这些毛病全是致命的；所以在学习这篇文档的同时也在用做笔记的方式去记录自己的对文档的理解；希望我的这份学习笔记可以帮助到大家一下进步成长！
        学习文档为："高质量C++/ C编程指南 "【作者 林锐】

高质量C++/ C编程指南-程序的版式

        程序的版式虽然不会影响程序的功能，但是会影响代码的可读性。程序的版式追求需要达到清晰、美观、是程序风格的重要构成因素。
        就好比我们写字一样，有人写出来的字鬼画符、有人写出来的字如螃蟹爬行、有人写出来的字规规正正就好比打印机打印出来的字让人一目了然；这样就有了对比，好的程序让开发者对程序一目了然，思绪容易跟上代码逻辑的编程走下去。坏的程序让开发者甚至今天写的代码明天就看不懂了，让维护者烦恼有加；所以我们需掌握程序的版式，弥补大学计算机教育的缺失；

空行

空行起着分离程序段落的作用。空行得体（不过多也不过少）会使得程序的布局更加清晰。空喊不会浪费内存。所以不要舍不得不用空行；
【空行规则1】在每个结构体、类声明之后、每个函数定义结束之后都要加空行。
【空行规则2】在一个函数体内，逻辑上密切相关的语句之间不加空行，其它地方应该加空行分隔；
示例如下：

代码行

【代码行规则1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释；

【代码行规则2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写误；

【代码行建议1】如果变量的引用处和定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。例如下方

代码行内的空格

【代码行内的空格规则1】关键字之后要留空格。像const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字。像if、for、while等关键字之后应留一个空格在跟左括号，以突出关键字；
【代码行内的空格规则2】函数名之后不要留空格，紧跟左括号，以与关键字区别。
【代码行内的空格规则3】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”、“>=”、“&&”、等二元操作符的前后应当加空格。
【代码行内的空格规则4】一元操作符如：“！”、“~”、“++”、“--”、“&”等前后不加空格
【代码行内的空格规则5】像“[ ]”、“.”、“->”这类操作符前后不加空格
 

对齐

【对齐规则1】程序的分界符“ { ”和“ } ”应独占一行并且位于同一列，同时与引用它们的语句左对齐
【对齐规则2】{ }之内的代码块在“ { ”右边数格处左对齐。

注释

使得C 语言的注释符为“/*…*/”。C++语言中，程序块的注释常采用“/*…*/”，行注释一般采用“//…”。注释通常用于：
（1）版本、版权声明；
（2）函数接口说明；
（3）重要的代码行或段落提示。
【注释规则1】注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。
【注释规则2】如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。
        例如： i++；        //i加1，多余的注释
【注释规则3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
【注释规则4】注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。
【注释规则5】尽量避免在注释中使用缩写，特别是不常用缩写。
【注释规则6】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。
【注释规则7】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

制作不易！喜欢的小伙伴给个小赞赞！喜欢我的小伙伴点个关注！有不懂的地方和需要的资源随时问我哟！