fe / yohobuy-node · Commits

Go to a project

Authored by xuqi
Commit 7c3ab526f1d41ab85dd4f4eb2b647c37684c74a8 1 parent 2cd9382d

markdown grammar

Inline Side-by-side
Showing 1 changed file with 12 additions and 13 deletions
@@ -11,25 +11,24 @@ @@ -11,25 +11,24 @@
11 * 建议将编辑器Tab映射成4个Space 11 * 建议将编辑器Tab映射成4个Space
12 12
13 ## 注释 13 ## 注释
14 -* 为每个你创建的JS文件添加注释  
15 -```html 14 +* 为每个你创建的JS文件添加注释
  15 +```
16 /** 16 /**
17 * 对文件实现功能的描述 17 * 对文件实现功能的描述
18 - * \@date: 2016-11-11  
19 - * \@author: name<emial@yoho.cn> 18 + * @date: 2016-11-11
  19 + * @author: name<emial@yoho.cn>
20 */ 20 */
21 ``` 21 ```
22 -* 为重要的函数添加注释  
23 -```html  
24 - /**  
25 - * 对函数功能的说明  
26 - * \@params name paramType 参数描述  
27 - * \@return name returnType 返回值描述 22 +* 为重要的函数添加注释
  23 +```
  24 + /**
  25 + * 对函数功能的说明
  26 + * @params name paramType 参数描述
  27 + * @return name returnType 返回值描述
28 */ 28 */
29 ``` 29 ```
30 -* 为重要的代码、逻辑复杂的代码或者有特殊处理的代码添加注释  
31 -```html  
32 - 30 +* 为重要的代码、逻辑复杂的代码或者有特殊处理的代码添加注释
  31 +```
33 // Your comments for the code 32 // Your comments for the code
34 ``` 33 ```
35 * 减少不必要的注释 34 * 减少不必要的注释