【编程人员必须遵循的编码规范】编码规范即我们在编写代码时需要遵守的一些规则 。好的编码规范可以大大提高代码的可读性和可维护性,甚至提高程序的可靠性和可修改性,保证了代码的质量 。特别是在团队开发大型项目时,编码规范就成为了项目高效运作的重要要素 。本文将简要介绍在编写C++程序时必须遵循的编码规范 。
养成良好的习惯
- 程序快缩进,要使用Tab键缩进,不能和空格键混合使用 。
- 函数不要太长,如果太长,建议拆分处理 。
- 不要使用太深的if嵌套语句,可以使用函数来代替 。
- 双目操作符号前后加空格,以更加醒目 。
- 单目操作符前后不加空格 。
- 不要使用太长的语句,如果太长,可以分行处理 。
- 每个模板中只有一个类 。
- if、while、for、case、default、do等语句要独占一行 。
- 一行不能写多条语句 。
- 如果表达式中有多个运算符,要用括号标出优先级 。
必须使用的注释注释可以帮助阅读程序,通常用于概括算法、确认变量的用途或者阐明难以理解的代码段 。注释并不会增加可执行程序的大小,编译器会忽略所有注释 。
C++中有两种类型的注释:单行注释和成对注释 。单行注释以双斜线(//)开头,行中处于双斜杠右边的内容是注释,被编译器忽略 。例如:
//计算m和n的和z=add(m,n);另一种定界符:注释对(/**/),是从C语言继承过来的 。这种注释以“/*”开头,以“*/”结尾,编译器把落入注释对“/**/”之间的内容作为注释 。例如:/*计算m和n的和Z只是个简单函数*/z=add(m,n);任何允许有制表符、空格或换行符的地方都允许放注释对 。注释对可跨越程序的多行,但不是一定要如此 。当注释跨越多行时,最好能直观地指明每一行都是注释的一部分 。我们的风格是在注释的每一行以星号开始,指明整个范围是多行注释的一部分 。程序通常混用两种注释形式 。注释对一般用于多行解释,而双斜线注释则常用于半行或单行的标记 。太多的注释混入程序代码可能会使代码难以理解,通常最好是将一个注释块放在所解释代码的上方 。
当改变代码时,注释应与代码保持一致 。程序员即使知道系统其他形式的文档已经过期,还是会信任注释,认为它会是正确的 。错误的注释比没有注释更糟,因为它会误导后来者 。
在使用注释时,必须遵循下述原则 。
- 禁止乱用注释 。
- 注释必须和被注释内容一致,不能描述和其无关的内容 。
- 注释要放在被注释内容的上方或被注释语句的后面 。
- 函数头部需要注释,主要包含文件名、作者信息、功能信息和版本信息 。
- 注释对不可嵌套:注释总是以“/*”开始并以“*/”结束 。这意味着,一个注释对不能出现在另一个注释对中 。由注释对嵌套导致的编译器错误信息容易使人迷惑 。
本文节选自《Visual C++ 开发从入门到精通》
推荐阅读
- 电脑主板为何必须要有电池呢?难道就不能够取消电池吗
- 这五个时间千万少喝茶
- 想在头条赚一份工资,必须避开这个最大的坑,这是运营告诉我的
- Go 并发编程的思考
- 科学家破解机体再生密码
- 职工社保转成灵活就业人员社保,怎么办理呢?
- 编程新手该如何调优程序?程序员必备性能调优利器——火焰图
- 写给开发人员的Web无障碍标准
- 整容|女子花近8万整容整成9级伤残,当事人:眼睛很痛不能出门,在家必须拉窗帘
- 不要随意触摸车内这四个按钮,否则会有车辆损坏和人员死亡的危险
