docs: 优化 JS/TS 基础规范中复杂逻辑注释规则的表述,将"超过 2 个"改为"大于等于 3 个"以更准确描述判断条件
This commit is contained in:
+14
-14
@@ -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) {
|
||||
// ...
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user