文件注释及 git 提交规范
# 文件注释及 git 提交规范
## 文件注释规范
### 新建 vue 文件
```html
<!--
* @desc: 入户调查办理页
* @author: xiaojiajia
* @Date: 2023/5/30
-->
<template>
...
</template>
```
1.desc：页面描述
2.author：创建人
3.Date：创建时间
> #### 设置方法
1.
2.
3. 代码文件
```js
// 头部注释
"fileheader.customMade": {
"desc": "", // 文件描述
"author": "git config user.name", // 文件的创建者
"Date": "Do not edit", // 文件创建时间
},
// 函数注释
"fileheader.cursorMode": {
"desc": "", // 文件描述
"author": "git config user.name", // 作者
"Date": "Do not edit", // 创建时间
},
"fileheader.configObj": {
"createFileTime": true, // 设置为true则为文件新建时候作为date，否则注释生成时间为date
"autoAdd": true, // 自动生成注释
"annotationStr": {
"head": "<!--",
"middle": " * @",
"end": "-->",
"use": true // 设置自定义注释可用
},
},
```
### 新建 js 方法 ==如js中有复杂判断，或者复杂逻辑，需要单行注释以做区分==
1. js 方法，无参数
```js
/**
* @description
* @author libiyun
* @create_date 2023/08/14 09:56
*/
```
2. js 方法，有参数
```js
/**
* @description
* @params ${参数}
* @author libiyun
* @create_date 2023/08/14 10:00
* return void
*/
```
> #### 设置方法，用户代码片段
1.
2.
3.
4. 代码文件
```js
{
"Print to jsCreate": {
"prefix": "jsCreate",
"body": [
"/**",
"* @description ",
"* @author libiyun",
"* @create_date ${CURRENT_YEAR}/${CURRENT_MONTH}/${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}",
"*/"
],
"description": "无参数"
},
"Print to jsParam": {
"prefix": "jsParam",
"body": [
"/**",
"* @description ",
"* @params ${参数}",
"* @author libiyun",
"* @create_date ${CURRENT_YEAR}/${CURRENT_MONTH}/${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}",
"* return void",
"*/"
],
"description": "有参数"
},
"Print to jsEdit": {
"prefix": "jsEdit",
"body": [
"*",
"* @modifier: libiyun",
"* @modifier_date: ${CURRENT_YEAR}/${CURRENT_MONTH}/${CURRENT_DATE} ${CURRENT_HOUR}:${CURRENT_MINUTE}",
"* modifierList: ",
],
"description": "js方法修改"
},
}
```
### 编辑 vue 文件，或者编辑 js 方法 ==修改他人文件时，必须加入此注释， 如若是本人文件，可加可不加；多人修改时，只保留创建人，及最新修改人的 2 条记录即可==
```html
/**
* @description
* @params ${参数}
* @author libiyun
* @create_date 2023/08/14 10:00
* return void
*
* @modifier: libiyun
* @modifier_date: 2023/08/14 10:04
* modifierList:
*/
```
1. 配置见上用户配置，jsEdit
### data部分需备注每个不通用字段的含义
```js
data() {
return {
// 基本通用部分
searchFieldList,
Column,
tableData: [],
loading: false,
// 不通用部分
bax74PoList1: [], // 家庭成员其他信息动态配置字段
bax74PoList2: [], // 赡养人动态配置字段
bax74PoList4: [], // 材料动态胚子
abe010: '', // key
type: {
uploadType: '0' //说明是上传到统一存储
},
}
},
```
1. 配置代码
## git 提交规范
```
【新增】1. 2. 3.
【需求变更】1. 2. 3.
【修复bug】1. 2. 3.
【优化】1. 2. 3.
【删除】1. 2. 3.
```
1. 【新增】：是指原没有相关模块或页面的情况下，新增了页面或者模块
2. 【需求变更】：是指原有的页面，在正常运行的情况下，新增或者变更了需求
3. 【修复 bug】：解决页面的 bug
4. 【优化】：不影响页面功能的情况下，对代码和样式进行优化
5. 【删除】：一般不删除
## 正式环境发包规范
正式环境打包后，在群里请求发包时，==备注本次发包的内容==