对于代码规范,不少朋友自己心中也没有个标准,基本都是怎么喜欢怎么来,但是这样并不是一个好的习惯,心中没有标杆,写出来的代码通常会比较难阅读,难以维护,更有可能出现意外的 BUG。
通常在公司开发产品,并不是全部都是一个人完成的(大神另说),一般都是多人协助完成的,每个都负责一个模块,每个人开完自己的负责的模块后,再做代码合并等工作,那么这个时候团队开发中的代码规范就很重要的了。
当然,每个公司都有自己的代码规范,但是我觉得要学习好的代码规范,要向行业顶尖的公司学习,Google作为技术顶尖公司,它的代码规范自然值得大家学习。
无意间发现了份 Google 代码规范学习指南,是针对开源项目的代码规范,该文档共规定出了 5 种编程语言,C++\Object-C\Python\Shell\Javascript。
C++ 规范
关于C++的规范,也截取部分出来,整体来看是比较细致,且有实践指导意义,比如对于头文件定义的约束:
所有头文件要能自给自足,用户和重构工具不需要为特别场合而包含额外头文件
Python 规范
下图截取自 Python 编码规范:
Objective-C 规范
Objective-C 部分编码规范:
Shell 规范
shell 部分编码规范:
javascript 规范
javascript 部分编码规范:
如你所见,谷歌的这份编码规范还是非常有参考价值的,分享给需要的同学,助你码到成功!
谷歌的代码规范文档我也共享给大家。