diff --git a/references/js&ts.base.md b/references/js&ts.base.md index 8f2d2eb..d844125 100644 --- a/references/js&ts.base.md +++ b/references/js&ts.base.md @@ -21,7 +21,7 @@ const maxCount = 100; ## 函数名使用小驼峰命名 `[JsTs.Base.FuncLowerCamel]` -> severity `warn` +> - severity `warn` ### Good @@ -41,7 +41,7 @@ function getuserinfo() { ## 禁止使用字面量魔法字符串和魔法数字 `[JsTs.Base.NoMagicStringsAndNumbers]` -> severity `warn` +> - severity `warn` - 只检查数字、字符串、正则字面量,不要检查其他(比如 布尔字面量、对象字面量、函数字面量、数组字面量) - 这块只检查含义不明确的字面量,比如 0 1 500 等,像是 'user' 'admin' 'active' 'inactive' 等是合理的 @@ -71,7 +71,7 @@ const userStatus = "active"; ## class 和 interface 命名使用大驼峰命名 `[JsTs.Base.ClassUpperCamel]` -> severity `warn` +> - severity `warn` ### Good @@ -91,7 +91,7 @@ class userinfo { ## 变量名使用小驼峰命名 `[JsTs.Base.VarLowerCamel]` -> severity `warn` +> - severity `warn` - 需要注意的是从 require 导入的变量不受检查 @@ -138,3 +138,49 @@ function getUserInfo() { // ... 大于 200 } ``` + +## 复杂的逻辑判断要添加注释 `[JsTs.Base.ComplexLogic]` + +> - severity `warn` + +- 逻辑判断的复杂度超过 2 个的要添加注释 + +### Good + +```javascript +// 逻辑判断复杂度超过 2 个 +if (a && b || c) { + // ... +} +``` + +### Bad + +```javascript +if (a && b && c && d) { + // ... +} +``` + +## 复杂的函数要添加注释 `[JsTs.Base.ComplexFunc]` + +> - severity `warn` + +### Good + +```javascript +/** + * 复杂的算法逻辑 + */ +function complexFunc() { + // ... +} +``` + +### Bad + +```javascript +function complexFunc() { + // ... +} +```