每一个专业的开源项目都有它自己的编码风格指南:一套关于如何为这个项目写代码的约定规范(有时是随意的)。当所有的代码都是始终遵循在这种规范的指导时,要理解一个大型的代码仓库之前,必然是先查看这套代码规范。
“风格”包含一个很大的范围,从 “为变量名使用camelCase(驼峰写法)” 到 “永远不使用全局变量”,再到 “永远不使用exceptions(通用异常类)”。本项目是我们为Google项目进行编码时的风格指南,您可能会指出在这一页看到的风格指南适用于此项目。
我们的 C++ Style Guide,Objective-C Style Guide,Java Style Guide,Python风格指南,R Style Guide,Shell Style Guide,HTML/CSS风格指南,JavaScript风格指南,AngularJS Style Guide,Common Lisp Style Guide, 和Vimscript Style Guide 现在都已经可用了。我们还发布了cpplint(一个帮助遵循代码风格指南的工具)和 google-c-style.el(一个为Google编码风格的Emacs settings 文件).
如果您的项目需要您创建一个新的XML文档格式,我们的XML 文档格式编码风格指南可能会有帮助。除格式的实际风格规则外,指南还涉及如何自主设计文档格式和改编已存在文档格式,如何进行实时XML文档格式编写,还有对元素和属性的建议。
此编码风格指南受CC-By 3.0 License许可,它鼓励你分享此文档,具体细节请查看 http://creativecommons.org/licenses/by/3.0/