From 8ac6f106796af60602687aacd3f2f8049a88b8b0 Mon Sep 17 00:00:00 2001 From: Lyda <1829913225@qq.com> Date: Wed, 29 Apr 2026 10:09:22 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BC=98=E5=8C=96=20JS/TS=20=E5=9F=BA?= =?UTF-8?q?=E7=A1=80=E8=A7=84=E8=8C=83=E4=B8=AD=E5=A4=8D=E6=9D=82=E9=80=BB?= =?UTF-8?q?=E8=BE=91=E6=B3=A8=E9=87=8A=E8=A7=84=E5=88=99=E7=9A=84=E8=A1=A8?= =?UTF-8?q?=E8=BF=B0,=E5=B0=86"=E8=B6=85=E8=BF=87=202=20=E4=B8=AA"?= =?UTF-8?q?=E6=94=B9=E4=B8=BA"=E5=A4=A7=E4=BA=8E=E7=AD=89=E4=BA=8E=203=20?= =?UTF-8?q?=E4=B8=AA"=E4=BB=A5=E6=9B=B4=E5=87=86=E7=A1=AE=E6=8F=8F?= =?UTF-8?q?=E8=BF=B0=E5=88=A4=E6=96=AD=E6=9D=A1=E4=BB=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- references/js&ts.base.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/references/js&ts.base.md b/references/js&ts.base.md index ae18783..331ba43 100644 --- a/references/js&ts.base.md +++ b/references/js&ts.base.md @@ -12,13 +12,13 @@ #### Good: 使用大写加下划线 ```javascript -const MAX_COUNT = 100; +const ROLE_ADMIN = 1; ``` #### Bad: 使用小驼峰 ```javascript -const maxCount = 100; +const roleAdmin = 1; ``` ## 函数名使用小驼峰命名 `[JsTs.Base.FuncLowerCamel]` @@ -66,9 +66,9 @@ function getuserinfo() { #### Good: 使用常量替代魔法数字 ```javascript -const ADMIN = 1; +const ROLE_ADMIN = 1; -if (user.role === ADMIN) { +if (user.role === ROLE_ADMIN) { // ... } ``` @@ -86,7 +86,7 @@ if (user.role === 1) { > - severity `error` - 需要放在指定模块的 constants 文件里 -- constants 命名规则: user.constants.js 或者 constants.js 或者 user.constants.ts 或者 constants.ts +- constants 命名规则: user.constants.js 或者 user.constants.ts ### Example: 常量定义位置 @@ -94,14 +94,14 @@ if (user.role === 1) { ```javascript // user.constants.js -const MAX_COUNT = 100; // 这是 user 模块需要的 +const ROLE_ADMIN = 1; // 这是 user 模块需要的 ``` #### Bad: 常量放在错误模块的 constants 文件 ```javascript // class.constants.js -const MAX_COUNT = 100; // 这是 user 模块需要的 +const ROLE_ADMIN = 1; // 这是 user 模块需要的 ``` ## class 和 interface 命名使用大驼峰命名 `[JsTs.Base.ClassNaming]` @@ -166,25 +166,25 @@ let Username = "John"; // 代码超过 700 行 ``` -## 单个函数或方法不能超出 200 行 `[JsTs.Base.FuncNotMoreThan200Lines]` +## 单个函数或方法不能超出 300 行 `[JsTs.Base.FuncNotMoreThan300Lines]` ### Example: 函数行数 -#### Good: 函数不超过 200 行 +#### Good: 函数不超过 300 行 ```javascript function getUserInfo() { - // ... 小于等于 200 + // ... 小于等于 300 } ``` -#### Bad: 函数超过 200 行 +#### Bad: 函数超过 300 行 > - includes `added|*` ```javascript function getUserInfo() { - // ... 大于 200 + // ... 大于 300 } ``` @@ -192,14 +192,14 @@ function getUserInfo() { > - severity `warn` -- 逻辑判断的复杂度超过 2 个的要添加注释 +- 逻辑判断的复杂度大于等于 3 个的要添加注释 ### Example: 复杂逻辑注释 #### Good: 复杂逻辑添加注释 ```javascript -// 逻辑判断复杂度超过 2 个 +// 逻辑判断复杂度大于等于 3 个 if (a && b || c) { // ... }