不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的。
永远遵循同一套编码规范,可以是这里列出的,也可以是你自己总结的。如果你发现本规范中有任何错误,敬请在 Issues 中指正。
项目名全部采用小写方式,以中划线分隔,禁止驼峰式命名。比如:my-project-name
文件命名参照项目命名规则。比如: error-report.html
有复数结构时,要采用复数命名法,比如: scripts, styles, images, data-models
文件名中只可由小写英文字母 az 、排序数字 09 或间隔符 - 组成,禁止包含特殊符号,比如空格、$ 等
为了醒目,某些说明文件的文件名,可以使用大写字母,比如: README, LICENSE
为更好的表达语义,文件名使用英文名词命名,或英文简写。
不允许命名带有广告等英文的单词,例如ad,adv,adver,advertising,防止该模块被浏览器当成垃圾广告过滤掉。任何文件的命名均如此。
文件常用命名:
-
index.shtml 引导页&首页
-
main.shtml 首页
-
download.shtml 下载页面
-
act.html 活动列表页面
-
video.html 视频
-
cdkey.html CDKEY页面
-
base.css 基本样式
-
layout.css 框架布局
-
module.css 模块样式
-
global.css 全局样式
-
font.css 字体样式
-
index.css 首页样式
-
link.css 链接样式
-
print.css 打印样式