Parcourir la source

typescript:feat:规范完善

haojianlong il y a 4 ans
Parent
commit
f4f19eba05
2 fichiers modifiés avec 27 ajouts et 27 suppressions
  1. 1 1
      docs/standard/typescript/README.md
  2. 26 26
      docs/standard/typescript/comment.md

+ 1 - 1
docs/standard/typescript/README.md

@@ -24,4 +24,4 @@
 * 循环、分支嵌套层次不要超过五层。
 * 注释可以与语句在同一行的右端,也可以在上行。
 * 一目了然的语句不加注释。
-* 代码的注释率(注释行数/文件总行数)不低于 30%。
+* 代码的注释率(注释行数/文件总行数)不低于 40%。

+ 26 - 26
docs/standard/typescript/comment.md

@@ -8,7 +8,7 @@
 多行注释规则:
 * 注释以“/**”开始,以“*/”结尾。
 * "/**"与“*/”各占一行;
-* 每一行注释都以“*”打头,在“*”与注释内容之间间隔一个空格;
+* 每一行注释都以“\*”打头,在“\*”与注释内容之间间隔一个空格;
 
 ## 写注释注意事项
 ### 什么时候编写注释
@@ -41,9 +41,9 @@
 
 函数的所有入参、返回值都必须写注释。
 
-所有的分支语句(if、else、switch 等)、循环语句(for、while、do...while 等)必须编写注释。
+所有的分支语句(```if``````else``````switch``` 等)、循环语句(```for``````while``````do...while``` 等)必须编写注释。
 
-switch 的每个 case 分枝都必须写注释。注释写在 ```case``` 语句右端。
+```switch``` 的每个 ```case``` 分枝都必须写注释。注释写在 ```case``` 语句右端。
 
 对于维护人员来说,良好的注释帮助更好的理解程序,有时甚至优于看设计文档。
 
@@ -89,7 +89,7 @@ switch 的每个 case 分枝都必须写注释。注释写在 ```case``` 语句
 /**
  * summary
  *
- * @author  author-text
+ * @author author-text
  */
 ```
 
@@ -104,7 +104,7 @@ switch 的每个 case 分枝都必须写注释。注释写在 ```case``` 语句
 
 **风格:**
 * 作者与简要说明隔一空行;
-* @author 标识与作者间用 tab 键完成定位;
+* @author 标识与作者间用 ```tab``` 键完成定位;
 * 多个作者,使用多个 @author 标记,每个作者占一行;
 * 姓名与㞨箱地址间隔一个空格;
 * 邮箱地址使用”<>“括起来。
@@ -117,8 +117,8 @@ switch 的每个 case 分枝都必须写注释。注释写在 ```case``` 语句
 /**
  * 对象
  *
- * @author  庞利祥 <sybotan@126.com>
- * @author  庞凌峰 <sandy@126.com>
+ * @author 郝洁 <haojie@persagy.com>
+ * @author 韩耀龙 <han_yao_long@163.com>
  */
 export class SObject {}
 ```
@@ -128,7 +128,7 @@ export class SObject {}
 /**
  *  命令日志接口
  *
- *  @author  庞利祥 <sybotan@126.com>
+ * @author 韩耀龙 <han_yao_long@163.com>
  * */
 export interface SICommandLog {}
 ```
@@ -139,8 +139,8 @@ export interface SICommandLog {}
 /**
   * summary
   *
-  * @param   parameter-name     description
-  * @return  return-description
+  * @param parameter-name   description
+  * @return return-description
   */
 ```
 **说明:**
@@ -164,13 +164,13 @@ export interface SICommandLog {}
 * 入参与出参与简要说明隔一空行;
 * 入参的顺序要与函数的定义保持一致;
 * 入参以有多个,每个入参单独占一行;
-* @param 标识与参数名间用 tab 键完成定位;
-* 多个参数数描述使用 tab 键完成对齐排版;
+* ```@param``` 标识与参数名间用 ```tab``` 键完成定位;
+* 多个参数数描述使用 ```tab``` 键完成对齐排版;
 * 一个入参有多种类型时,每种类型的描述使用 “|” 分开。注意描述与“|”留至少一个空格。
 * 入参与返回值描述与简要描述之间隔一空行;
-* 函数最多只能有一个 @return 标识。如果函数类的返回类型为 ```void``` ,则没有 @return 标识;
-* @return 标识不能排在 @param 标识前边;
-* @return 标识与返回值描述间用 ```tab``` 键完成定位;
+* 函数最多只能有一个 ```@return``` 标识。如果函数类的返回类型为 ```void``` ,则没有 @return 标识;
+* ```@return``` 标识不能排在 @param 标识前边;
+* `@return` 标识与返回值描述间用 ```tab``` 键完成定位;
 
 **示例:**
 
@@ -180,9 +180,9 @@ export class SRect {
     /**
      * 生成平移矩形
      *
-     * @param   dx      x 轴位移
-     * @param   dy      y 轴位移
-     * @return  移动后的矩形
+     * @param dx    x 轴位移
+     * @param dy    y 轴位移
+     * @return 移动后的矩形
      */
     translated(dx: number, dy: number): SRect {
         return new SRect(this.x + dx, this.y + dy, this.width, this.height);
@@ -196,10 +196,10 @@ export class SRect {
     /**
      * 构造函数
      *
-     * @param   x           x 轴坐标 | 左上角坐标
-     * @param   y           y 轴坐标 | 右下角坐标 | 大小
-     * @param   width       宽度
-     * @param   height      高度
+     * @param x         x 轴坐标 | 左上角坐标
+     * @param y         y 轴坐标 | 右下角坐标 | 大小
+     * @param width     宽度
+     * @param height    高度
      */
     constructor(
         x?: number | SPoint,
@@ -216,8 +216,8 @@ export class SRect {
    /**
      * 平移矩形
      *
-     * @param   dx      x 轴位移
-     * @param   dy      y 轴位移
+     * @param dx    x 轴位移
+     * @param dy    y 轴位移
      */
     translate(dx: number, dy: number): void {
         this.x += dx;
@@ -232,7 +232,7 @@ export class SRect {
     /**
      * 计算中心点
      *
-     * @return  中心点坐标
+     * @return 中心点坐标
      */
     center(): SPoint {
         return new SPoint(
@@ -324,7 +324,7 @@ export class SRect {
 /**
  * 手势状态
  *
- * @author  庞利祥 <sybotan@126.com>
+ * @author 韩耀龙 <han_yao_long@163.com>
  */
 export enum STouchState {
     None,       /** 标准状态 */