Showing
1 changed file
with
15 additions
and
10 deletions
@@ -12,22 +12,27 @@ | @@ -12,22 +12,27 @@ | ||
12 | 12 | ||
13 | ## 注释 | 13 | ## 注释 |
14 | * 为每个你创建的JS文件添加注释 | 14 | * 为每个你创建的JS文件添加注释 |
15 | + | ||
15 | ``` | 16 | ``` |
16 | /** | 17 | /** |
17 | - * 对文件实现功能的描述 | ||
18 | - * @date: 2016-11-11 | ||
19 | - * @author: name<emial@yoho.cn> | ||
20 | - */ | 18 | + * 对文件实现功能的描述 |
19 | + * @date: 2016-11-11 | ||
20 | + * @author: name<emial@yoho.cn> | ||
21 | + */ | ||
21 | ``` | 22 | ``` |
23 | + | ||
22 | * 为重要的函数添加注释 | 24 | * 为重要的函数添加注释 |
25 | + | ||
23 | ``` | 26 | ``` |
24 | /** | 27 | /** |
25 | - * 对函数功能的说明 | ||
26 | - * @params name paramType 参数描述 | ||
27 | - * @return name returnType 返回值描述 | ||
28 | - */ | 28 | + * 对函数功能的说明 |
29 | + * @params name paramType 参数描述 | ||
30 | + * @return name returnType 返回值描述 | ||
31 | + */ | ||
29 | ``` | 32 | ``` |
33 | + | ||
30 | * 为重要的代码、逻辑复杂的代码或者有特殊处理的代码添加注释 | 34 | * 为重要的代码、逻辑复杂的代码或者有特殊处理的代码添加注释 |
35 | + | ||
31 | ``` | 36 | ``` |
32 | // Your comments for the code | 37 | // Your comments for the code |
33 | ``` | 38 | ``` |
@@ -41,6 +46,6 @@ | @@ -41,6 +46,6 @@ | ||
41 | * html中请不要出现不必要的嵌套以及不要将标签滥用,比如使用`a`标签作为不跳转的按钮的标签 | 46 | * html中请不要出现不必要的嵌套以及不要将标签滥用,比如使用`a`标签作为不跳转的按钮的标签 |
42 | * 属性按顺序出现:`id -> class -> name -> data-* -> src,for,type,href -> title,alt -> aria-*,role` | 47 | * 属性按顺序出现:`id -> class -> name -> data-* -> src,for,type,href -> title,alt -> aria-*,role` |
43 | 48 | ||
44 | -## [js](./js.md) | 49 | +## [js](doc/code-norm/js.md) |
45 | 50 | ||
46 | -## [css](./css.md) | ||
51 | +## [css](doc/code-norm/css.md) |
-
Please register or login to post a comment