Skip to content

Commit 6011cdd

Browse files
committed
add file name rules
add file name rules
1 parent d88ec4f commit 6011cdd

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
3. [通用约定](#general)
88
* [文档目录结构](#directory)
99
* [分离](#separate)
10+
* [文件命名](#file-name)
1011
* [缩进](#indentation)
1112
* [编码](#encoding)
1213
* [小写](#lowercase)
@@ -118,13 +119,29 @@
118119

119120
> 将结构与表现、行为分离,保证它们之间的最小耦合,这对前期开发和后期维护都至关重要。
120121
122+
<a name="file-name"></a>
123+
### 3.文件命名
124+
125+
* CSS模块文件,其文件名必须与模块名一致;
126+
127+
假定有这样一个模块:
128+
129+
.m-detail{ sRules; }
130+
.m-detail-hd{ sRules; }
131+
.m-detail-bd{ sRules; }
132+
.m-detail-ft{ sRules; }
133+
134+
> 那么该模块的文件名应该为:`m-detal.css`
135+
136+
* CSS页面文件,其文件名必须与HTML文件名一致;
137+
121138
<a name="indentation"></a>
122-
### 3.缩进
139+
### 4.缩进
123140

124141
使用tab(4个空格宽度)来进行缩进,可以在IDE里进行设置
125142

126143
<a name="encoding"></a>
127-
### 4.编码
144+
### 5.编码
128145

129146
* 以 UTF-8 无 BOM 编码作为文件格式;
130147
* 在HTML中文档中用 `<meta charset="utf-8" />` 来指定编码;
@@ -133,19 +150,19 @@
133150
> 在sass中,如果文档中出现中文,却未显示定义编码,将会编译出错,为了统一各种写法,且提前规避错误几率,统一要求每个CSS文档都需要定义编码
134151
135152
<a name="lowercase"></a>
136-
### 5.小写
153+
### 6.小写
137154

138155
* 所有的HTML标签必须小写;
139156
* 所有的HTML属性必须小写;
140157
* 所有的样式名及规则必须小写。
141158

142159
<a name="comment"></a>
143-
### 6.注释
160+
### 7.注释
144161

145162
尽可能的为你的代码写上注释。解释为什么要这样写,它是新鲜的方案还是解决了什么问题。
146163

147164
<a name="todo"></a>
148-
### 7.待办事项
165+
### 8.待办事项
149166

150167
用 TODO 标示待办事项和正在开发的条目
151168

@@ -158,12 +175,12 @@
158175
.g-imgtext{ sRules }
159176

160177
<a name="end-line-space"></a>
161-
### 8.行尾空格
178+
### 9.行尾空格
162179

163180
删除行尾空格,这些空格没有必要存在
164181

165182
<a name="protocol-relative-url"></a>
166-
### 9.省略嵌入式资源协议头
183+
### 10.省略嵌入式资源协议头
167184

168185
省略图像、媒体文件、样式表和脚本等URL协议头部声明 ( http: , https: )。如果不是这两个声明的URL则不省略。
169186

@@ -196,7 +213,7 @@
196213
> 注:省略协议头在IE7-8下会有一点小问题,外部CSS文件(link和@import)会被下载两遍,所以该条目的约定看具体项目。
197214
198215
<a name="validator"></a>
199-
### 10.代码有效性
216+
### 11.代码有效性
200217

201218
* 使用 [W3C HTML Validator](http://validator.w3.org/) 来验证你的HTML代码有效性;
202219
* 使用 [W3C CSS Validator](http://jigsaw.w3.org/css-validator/) 来验证你的CSS代码有效性。

0 commit comments

Comments
 (0)