docs(projects): 文档更新

doc/命名规范.md

@@ -1,15 +1,28 @@
-### 驼峰式命名法：
-**Pascal Case大驼峰式命名法：**
-首字母大写。eg：StudentInfo、UserInfo、ProductInfo
-**Camel Case 小驼峰式命名法：**
-首字母小写。eg：studentInfo、userInfo、productInfo
+### 命名法：
+
+#### 1.驼峰命名法(小驼峰)
+
+**getUser**
+
+#### 2.帕斯卡命名法(大驼峰)
+
+ **GlobalHeader**
+
+#### 3.短横线命名法
+
+**user-center**
+
+#### 4.下划线命名法
+
+ **MAX_LENGTH**
 
 ### 文件、文件夹命名：
-1. 文件夹作为**页面**时用小写字母，包含多个单词时，单词之间建议使用半角的连词线 ( - ) 分隔。
-2. 文件夹作为**组件**时用大写驼峰命名。
-3. 文件作为**组件**时用大写驼峰命名。
-4. 文件作为**use函数**时用小驼峰命名。
-5. 其余文件用小写字母，包含多个单词时，单词之间建议使用半角的连词线 ( - ) 分隔。
+
+1. 文件夹作为**路由页面**时用小写字母，包含多个单词时，单词之间建议使用半角的连词线 ( - ) 分隔, 即**短横线命名法**，此时vue文件为**index.vue**。
+2. 文件夹作为**vue组件**时用**大写驼峰命名法**。
+3. 文件作为**vue组件**时用**大写驼峰命名法**。
+4. 文件作为**use函数**时用**小驼峰命名法**。
+5. 其余文件用**短横线命名法**。
 
 ### 变量命名：
 #### 命名方式 : 小驼峰式命名方法
@@ -23,15 +36,13 @@ is | 判断是否为某个值 | 函数返回一个布尔值。true：为某个
 get | 获取某个值 | 函数返回一个非布尔值。
 set | 设置某个值 | 无返回值、返回是否设置成功或者返回链式对象。
 
-- 推荐：
-
 ```javascript
-//是否可读
+/** 是否可读 */
 function canRead(){
 	return true;
 }
 
-//获取姓名
+/** 获取姓名 */
 function getName(){
   return this.name;
 }
@@ -39,17 +50,23 @@ function getName(){
 
 
 ### 常量
-#### 命名方法 : 全部大写
-**命名规范 : 使用大写字母和下划线来组合命名，下划线用以分割单词。**
-- 推荐：
-
+#### 命名方法 : 使用大写字母和下划线来组合命名，下划线用以分割单词。
 ```javascript
 const MAX_COUNT = 10;
 const URL = 'http://www.baidu.com';
 ```
 
-### TS类型
+### TS类型接口interface和type
 
-命名统一使用大写驼峰
+##### 命名方法：大写驼峰
 
-interface和type使用优先级：能用interface表示的类型就用interface。
+```typescript
+interface PersonInfo {
+  /**姓名 */
+  name: string;
+  /**性别 '0':男; '1': 女; '2': 未知 */
+  gender: '0' | '1' | '2';
+  /**年龄 */
+  age: 25;
+}
+```