mirror of
https://github.com/m-xlsea/ruoyi-plus-soybean.git
synced 2025-09-24 07:49:47 +08:00
docs(projects): 文档更新
This commit is contained in:
55
doc/命名规范.md
Normal file
55
doc/命名规范.md
Normal file
@ -0,0 +1,55 @@
|
||||
### 驼峰式命名法:
|
||||
**Pascal Case大驼峰式命名法:**
|
||||
首字母大写。eg:StudentInfo、UserInfo、ProductInfo
|
||||
**Camel Case 小驼峰式命名法:**
|
||||
首字母小写。eg:studentInfo、userInfo、productInfo
|
||||
|
||||
### 文件、文件夹命名:
|
||||
1. 文件夹作为**页面**时用小写字母,包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔。
|
||||
2. 文件夹作为**组件**时用大写驼峰命名。
|
||||
3. 文件作为**组件**时用大写驼峰命名。
|
||||
4. 文件作为**use函数**时用小驼峰命名。
|
||||
5. 其余文件用小写字母,包含多个单词时,单词之间建议使用半角的连词线 ( - ) 分隔。
|
||||
|
||||
### 变量命名:
|
||||
#### 命名方式 : 小驼峰式命名方法
|
||||
**命名规范 : 类型+对象描述的方式,如果没有明确的类型,就可以使前缀为名词**
|
||||
|
||||
动词 | 含义 | 返回值
|
||||
---|---|---
|
||||
can | 判断是否可执行某个动作 | 函数返回一个布尔值。true:可执行;false:不可执行。
|
||||
has | 判断是否含有某个值 | 函数返回一个布尔值。true:含有此值;false:不含有此值。
|
||||
is | 判断是否为某个值 | 函数返回一个布尔值。true:为某个值;false:不为某个值。
|
||||
get | 获取某个值 | 函数返回一个非布尔值。
|
||||
set | 设置某个值 | 无返回值、返回是否设置成功或者返回链式对象。
|
||||
|
||||
- 推荐:
|
||||
|
||||
```javascript
|
||||
//是否可读
|
||||
function canRead(){
|
||||
return true;
|
||||
}
|
||||
|
||||
//获取姓名
|
||||
function getName(){
|
||||
return this.name;
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### 常量
|
||||
#### 命名方法 : 全部大写
|
||||
**命名规范 : 使用大写字母和下划线来组合命名,下划线用以分割单词。**
|
||||
- 推荐:
|
||||
|
||||
```javascript
|
||||
const MAX_COUNT = 10;
|
||||
const URL = 'http://www.baidu.com';
|
||||
```
|
||||
|
||||
### TS类型
|
||||
|
||||
命名统一使用大写驼峰
|
||||
|
||||
interface和type使用优先级:能用interface表示的类型就用interface。
|
Reference in New Issue
Block a user