姗姗来迟的代码规范
学习建议
- 代码规范是很重要的, 要重视!
- 个人感觉代码规范是代码的灵魂!(重视每一行代码)
- 认为代码规范没有什么用处, 你就大错特错了
整洁的代码
混乱的代码会有什么后果
- 进度延缓的程序会很严重, 即使你有一年的时间, 你也会像蜗牛一样, 很缓慢
- 当程序出现了错误的时候, 更改代码会眼花缭乱!
- 随着混乱的增加, 生产力也持续下降。
结论: 当你写出了好看的代码, 不仅加快了开发速度, 而且会事半功倍
如何写出整洁的代码
- 越小越好
- 在意代码、 在意细节
- 没有重复的代码
- 有责任心
- 代码清晰、 简洁
- 准守规则
比如 int a = 5; √
B = 6 × 为什么错, 因为没有定义变量b, 应该遵循规则, 先定义变量赋值。
代码总体原则 (摘抄自华为C语言编程规范)
一、 清晰第一
扫描二维码关注公众号,回复: 2335537 查看本文章清晰性是易于维护的必须具备特征。
二、 简洁为美
简洁就是易于理解并且易于实现。
选择合适的风格, 与代码原有风格保持一致, 如果重构、修改其他风格的代码时, 比较明智的做法就是根据现有代码的现有风格编写。
头文件
尽量单一。
A.h头文件不要包含b.h头文件。
禁止在头文件中定义变量。
函数
一个函数只完整一件功能, 越小越好。
重复的代码尽可能提炼成函数。 (讲函数的时候再说)
没有调用的代码及时清除, 如果觉得可能会用到, 可以先注释掉。
文件名
统一采用小写字符。
变量名
全局变量 应增加“g_”前缀。
局部变量 应增加”s_”前缀。
尽量不要再8个字符以外, 比如clock可以写成clk。
缩进
以四个空格缩进。
对于不同的开发工具自动生成的代码不一致。
注释
一般情况下, 源程序的注释必须在%20以上。
注释语言必须准确, 易懂, 简洁。
文件头部必须列出版权声明, 版本号, 生成日期, 作者, 内容, 功能, 修改日记, 目的等。
课后作业
- 自己寻找多一些代码规范的文章, 多去看看! 代码规范真的! 真的! 真的! 很重要!
- 在本文下方评论(指正作者的错误 与 随笔意见), 让作者写出更好的文章。