PDF《1. 关于》

1.

关于 2. 引言 3. 前端一般性规范 4. HTML 规范 5. CSS 规范 6. JavaScript 规范 7. Java 规范 8. Go 规范 9. PHP 规范 10. Python 规范 11. SQL 规范 12. JSON 规范 13. 附录 i. 谷歌是如何做代码审查的 ii. 为什么谷歌要执行严格的代码编写规范 目录 代码编写规范

2 这份文档是我个人根据过往经验、他人建议收集、整理、编排的关于常见语言编程风格规范的完整定义. 当且仅当一个项目文件符合此文档中的规则, 我们才认为它符合本文档的编程风格. 与其它的编程风格指南一样,这里所讨论的不仅仅是编码格式美不美观的问题, 同时也讨论一些约定及编 码标准.然而,这份文档主要侧重于我们所普遍遵循的规则, 对于那些不是明确强制要求的,我们尽量避 免提供意见. 如果对于本文档有任何意见或者建议,欢迎您随时发送邮件给我,大家共同探讨编码规范性,我们希望: 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. 邮箱地址:[email protected] 关于 代码编写规范

3 关于 引言 代码编写规范

4 引言 更新时间:2015年4月25日 版本:2015.04.25.00 修订:潘韬 2015-04-25:第一新修订,潘韬 这是一份旨在增强团队的开发协作,提高代码质量和打造开发基石的编码风格规范,其中包含了 HTML, JavaScript 和 CSS/SCSS 这几个部分. 我们知道,当一个团队开始指定并实行编码规范的话,错误就会变得更加显而易见.如果一段特定的代码 不符合规范的话,它有可能只是代码风格错误,而也有可能会是 bug.早期指定规范就使得代码审核得以 更好的开展,并且可以更精确的地定位到错误. 只要开发者们能够保证源代码源文件都严格遵循规范,那接下去所使用的混淆、压缩和编译工具则可投其 所好不尽相同. 以下章节列举了一些可应用在 HTML, JavaScript 和 CSS/SCSS 上的通用规则. 前端项目统一按以下目录结构管理项目文件: /path/to/PROJECT_NAME/ scss/ base.scss main.scss _module_name.scss scripts/ build.js gulp.js build/ vendor/ THIRD_PARTY_LIBRARY_NAME/ VERSION/ MINIFIED_FILE_NAME/ assets/ css/ base.min.css base.min.map main.min.css 前端一般性规范 历史修订 说明 规范内容 前端项目文件结构 代码编写规范

5 前端一般性规范 main.min.map img/ logo.png [email protected] [email protected] js/ main.min.js main.min.map index.html layout.html PAGE_NAME.html template/ vendor/ THIRD_PARTY_LIBRARY_NAME/ VERSION/ MINIFIED_FILE_NAME/ assets/ css/ base.css main.css img/ logo.png js/ main.js index.html layout.html PAGE_NAME.html 在上面的目录结构中,大写的名称为可变的,即根据具体需求随时更换,它们的语义分别为: PROJECT_NAME 当前项目的英文名称(若叮当钱包官方无法给出标准翻译,或者拼音即是其名称,则使用拼音全称, 或者使用其官方定义的短名称),由纯小写字母 a-z 或者数字 0-9 以及中划线 - 组成的字符串 template 模板目录,用于开发使用 build 构建目录 vendor 所有第三方的文件均存放在 vendor 目录中,在 vendor 中,任何第三方库、样式、脚本等均需要遵 守以下规则存放:任何一个第三方库均需要存放在其名称下,在开发过程中,使用 bower 安装. 在 web 项目中,所有的文件名应该都遵循同一命名约定.以可读性而言,减号( - )是用来分隔文件名的 不二之选.同时它也是常见的 URL 分隔符(i.e. //example.com/blog/my-blog-entry 或者 //s.example.com/images/big-black-background.jpg ),所以理所当然的,减号应该也是用来分隔资 文件/资源命名 代码编写规范