1、前言
关于代码编程规范,从上篇了解到编程规则和编程规范的区别后,那么这篇介绍一下代码编程规范包括什么、具体有哪些原则。
2、范围
1 排版风格
代码规范化中的排版基本上有七大风格,主要体现在缩进、空行、代码行、空格、成对书写、对齐、注释七方面的书写规范上。
2 命名方式
主要包括文件名、类、函数、变量和接口等方面
3 注释风格
主要包括注释、文件注释、类注释、方法注释、参数注释、变量注释和代码片段注释等
4 其他的扩展
包括接口头文件的布局、函数的功能、变量的用途、宏定义、复合表达式、if判断、循环语句、和类型定义等等
3、原则
1 清晰第一
清晰性是易于维护、易于重构的程序必需具备的特征,一般情况下,代码的可阅读性高于性能,只有确定性能是瓶颈时,才应该主动优化
2 简洁为美
代码越简单越好,代码一行只做一件事,一个函数只完成一个功能等,代码越长越难以看懂,也就越容易在修改时引入错误
3 选择合适的风格,与代码原有风格保持一致
因为软件开发不可避免要维护他人代码或者和他人合作开发,此时就需要尽可能和与原有代码风格保持一致或者和合作者达成共识的代码风格,否则每个人都使用自己的代码风格,在阅读时变得十分吃力
4 注释一定要和代码保持同步
很多情况下,代码功能修改后,都忘记修改注释,容易导致过段时间自己回头看过于纠结注释和功能不一致的情况