开发文档

杨泽宇
1 parent 54f99a8b
Showing 17 changed files with 582 additions and 2 deletions
README.md
docs/.nojekyll
docs/README.md
docs/_sidebar.md
docs/develop/category.md
docs/develop/component.md
docs/develop/contact.md
docs/develop/dict.md
docs/develop/discuss.md
docs/develop/global.md
docs/develop/history.md
docs/develop/index.md
docs/develop/question.md
docs/develop/validate.md
docs/index.html
package.json
src/utils/tool.ts
@@ -20,6 +20,7 @@ cnlive-community-web-vue 中国网+智慧社区平台
 + 本地运行：npm run dev
 + 测试环境打包：npm run build:stage
 + 正式环境打包：npm run build:prod
++ 文档本地预览：npm run doc
  
 ## 项目域名
 + 正式：
+# 项目介绍
+
+## 基本情况
+* 中国网+智慧社区是以权威资讯、社交、电商为一体为社区群众提供政务、购物、娱乐、教育、餐饮及生活互助等多种便捷服务的一款APP。
+* 中国网+智慧社区平台是以为APP配套的便捷易用的管理后台。
+
+## 目标
+* 以智慧民生改善人民生活
+* 以智慧家庭打造智能生活
+* 以智慧小区提升社区品质
+
+## 项目特点
+* 前后端分离 
+* 单页面应用SPA
+* 模板方案 
+* 网站模板与网站程序完全分离 
+* 操作方式方便、易用、人性化
+
+## 技术栈
+   * vite ^2.7.2
+   * vue ^3.2.25   
+   * node ^12.0.0
+   * element-plus ^1.0.0
+   * pinia ^2.0.9
+   * vue-router ^4.0.12
+   * axios ^0.14.0
+   * typescript ^4.4.4 
+   * [更多](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/package.json "更多")
+
+## 功能模块
+   * 服务管理
+   * 系统管理
+   * 小区管理
+   * 居民管理
+   * 物业管家
+   * 活动管理
+* [项目介绍](/)
+* [开发须知](develop/index.md)
+* [枚举字典](develop/dict.md)
+* [公用组件](develop/component.md)
+* [全局对象](develop/global.md)
+* [校验函数](develop/validate.md)
+* [使用问题](develop/question.md)
+* [注意事项](develop/discuss.md)
+* [联系作者](develop/contact.md)
+* [更新日志](develop/history.md)
 \ No newline at end of file
+## 目录结构
+
+```text
+│  .env.development // 本地开发环境配置
+│  .env.production // 线上部署正式环境配置
+│  .env.staging // 线上部署测试环境配置
+│  .gitignore // 不上传git的文件配置
+│  ie.html // IE浏览器拦截提示页面
+│  index.html // 入口html
+│  package-lock.json // 资源包
+│  package.json // 资源包
+│  README.md // 项目说明
+│  tsconfig.json // typescript配置文档
+│  vite.config.ts // vite配置文档
+├─.vscode
+├─public 静态资源
+└─src
+    ├─@type
+    │  └─module // ts module 定义
+    ├─api // 接口请求
+    │  ├─community // 小区
+    │  ├─event // 公益活动
+    │  ├─housekeeper // 楼宇
+    │  ├─notify // 公告
+    │  ├─ownerManagement // 居民
+    │  ├─property // 服务
+    │  └─user // 用户
+    │      ├─login // 登录
+    │      ├─permission // 权限
+    │      ├─role // 角色
+    │      └─user // 用户
+    ├─assets // 静态资源
+    │  └─404_images // 404页面装饰图
+    ├─components // 公共组件
+    │  ├─FileUpload // 单文件上传
+    │  ├─Pagination // 分页
+    │  └─Uploader // 单图片上传
+    ├─layout // 公共布局
+    ├─pinia // 状态管理
+    │  └─modules
+    ├─router // 路由
+    │  └─modules
+    ├─style // 样式
+    ├─utils // 全局方法、变量
+    └─views // 页面视图
+        ├─column 
+        ├─community
+        │  ├─housekeeper 
+        │  ├─houses 
+        │  └─residence 
+        ├─dashboard
+        ├─error
+        ├─event
+        │  ├─category
+        │  └─handwork
+        ├─housekeeper
+        │  └─buildinMganager
+        ├─maintain
+        ├─notify
+        ├─ownerManagement
+        │  └─owner
+        ├─permission
+        ├─property
+        ├─repair
+        ├─role
+        ├─serviceman
+        ├─system
+        └─user
+```
 \ No newline at end of file
+# 公用组件
+
+## 公共布局
+  * 代码位置：[src/layout](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/layout)
+  * enter：入口文件
+  * header：头部
+  * menu：侧导航
+  * icon：侧导航菜单图标
+
+## 分页
+  * 代码位置：[src/components/Pagination](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/components/Pagination)
+  * Emit: `pageChange(currentPage, pageSize, tagName)`
+  * 组件属性：
+
+    | propName | propType | propAttr | propDesc | propDefault |
+    | :-----: | :-----: | :-----: | :--: | :--: |
+    | total | `Number` | required | 内容总条数 | 0 |
+    | pageSizes | `Number[] null` | optional | 每页显示个数选择器的选项设置 | [10, 20, 50, 100] |
+    | pageSize | `Number` | optional | 当前每页内容条数 | 10 |
+    | currentPage | `Number` | optional | 当前页码 | 1 |
+    | tagName | `String` | optional | 标签 | |
+
+## 单文件上传
+  * 代码位置：[src/components/FileUpload](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/components/FileUpload)
+  * Emit: `success()`
+  * 组件属性：
+
+    | propName | propType | propAttr | propDesc | propDefault |
+    | :-----: | :-----: | :-----: | :--: | :--: |
+    | url | `String` | required | 上传地址 |  |
+    | method | `String` | required | 请求方式 |  |
+
+## 单图上传
+  * 代码位置：[src/components/Uploader](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/components/Uploader)
+  * Emit: `imageChange(url, tagName)`
+  * 组件属性：
+
+    | propName | propType | propAttr | propDesc | propDefault |
+    | :-----: | :-----: | :-----: | :--: | :--: |
+    | tagName | `String` | optional | 标签 |  |
+    | maxSize | `Number` | optional | 图片尺寸上限 | 1MB |
+    | defaultUrl | `String` | optional | 默认图片 |  |
+    | moduleName | `String` | optional | 后台交互用的module值 | test |
+    | tip | `String` | optional | 上传须知 | 支持16：9 的图片，建议最佳尺寸：750*422，大小不能超过500KB |
+    | showType | `String` | optional | 组件尺寸 | [图片布局](develop/component?id=图片布局) |
+    | formats | `Array<String>` | optional | 图片格式 | [图片格式](develop/component?id=图片格式) |
+
+
+
+## 图片格式
+  * image/jpeg
+  * image/gif
+  * image/png
+  * image/x-icon
+  * image/svg+xml
+  * image/webp
+
+
+## 图片布局
+  * horizontal = default 横图
+  * vertical 竖图
+  * square 正图
+  * mini 小正图
 \ No newline at end of file
+# 联系作者
+  
+## 联系开发团队
+  * [杨泽宇 PC前端](http://bj.gitlab.cnlive.com/u/yangzeyu "联系作者")
+  * [张红振 PC前端](http://bj.gitlab.cnlive.com/u/zhanghongzhen "联系作者")
+  * [国亚奇 JAVA后台](http://bj.gitlab.cnlive.com/u/guoyaqi "联系作者")
+  * [马亚鑫 JAVA后台](http://bj.gitlab.cnlive.com/u/mayaxin "联系作者")
+  * [王伊鹏 JAVA后台](http://bj.gitlab.cnlive.com/u/wangyipeng "联系作者")
+  * [赵明星 JAVA后台](http://bj.gitlab.cnlive.com/u/zhaomingxing "联系作者")
+  * [李发霖 产品经理](http://bj.gitlab.cnlive.com/ "联系作者")
 \ No newline at end of file
+# 枚举字典
+
+## 服务管理
+  * **栏目管理**
+      * 栏目类型  `types: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/column/config.ts)
+        | label | value |
+        | :---: | :---: |
+        | 权威资讯 | 1 |
+        | 公益活动 | 2 | 
+        | 服务 | 3 |
+
+      * 栏目状态  `statusEnum: Enum`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/column/index.vue)
+        | label | value |
+        | :---: | :---: |
+        | 隐藏 | 0 |
+        | 显示 | 1 | 
+        | 删除 | 2 | 
+
+  * **入驻管理**
+    * 入驻类型  `typeEnum: Enum`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/property/index.vue)
+        | label | value |
+        | :---: | :---: |
+        | 物业 | 1 |
+        | 公益 | 2 | 
+
+    * 公司状态  `statusEnum: Enum`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/property/index.vue)
+        | label | value |
+        | :---: | :---: |
+        | 禁用 | 0 |
+        | 启用 | 1 | 
+
+## 系统管理
+  * **权限管理**
+    * 菜单类型  `typeEnum: Enum`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/permission/index.vue)
+      | label | value |
+      | :---: | :---: |
+      | 一级菜单 | 1 |
+      | 二级菜单 | 2 | 
+      | 三级菜单 | 3 |
+      | 按钮 | 4 |
+      | 默认权限 | 5 |
+
+## 小区管理
+  * **楼宇管理**
+    * 楼管类型  `data.options: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/community/housekeeper/changeAdmin.vue)
+      | label | value |
+      | :---: | :---: |
+      | 选举 | 0 |
+      | 派驻 | 1 |
+
+  * **房屋管理**
+    * 是否居住  `data.livingList: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/community/housekeeper/changeAdmin.vue)
+      | label | value |
+      | :---: | :---: |
+      | 不在住 | 0 |
+      | 在住 | 1 |
+
+    * 类型  `data.ownerList: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/community/house/buildOwner.vue)
+      | label | value |
+      | :---: | :---: |
+      | 租户 | 0 |
+      | 业主 | 1 |
+      | 家人 | 2 |
+      | 朋友 | 3 |
+
+## 居民管理
+  * **居民管理**
+    * 居民类型  `data.options: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/ownerManagement/owner/index.vue)
+      | label | value |
+      | :---: | :---: |
+      | 业主 | 1 |
+      | 租户 | 2 |
+      | 住户 | 3 |
+
+    * 性别 `data.genderList: Array` [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/ownerManagement/owner/detail.vue)
+      | label | value |
+      | :---: | :---: |
+      | 女 | 0 |
+      | 男 | 1 |
+
+    * 婚姻状态 `data.isMarriedList: Array` [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/ownerManagement/owner/detail.vue)
+      | label | value |
+      | :---: | :---: |
+      | 未婚 | 0 |
+      | 已婚 | 1 |
+      | 离异 | 2 |
+      | 丧偶 | 3 |
+
+    * 政治面貌 `data.politicalList: Array` [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/ownerManagement/owner/detail.vue)
+      | label | value |
+      | :---: | :---: |
+      | 群众 | 0 |
+      | 党员 | 1 |
+      | 团员 | 2 |
+
+    * 户口类型 `data.censusList: Array` [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/ownerManagement/owner/detail.vue)
+      | label | value |
+      | :---: | :---: |
+      | 非城镇户口 | 0 |
+      | 城镇户口 | 1 |
+      | 外阜 | 2 |
+
+    * 居住类型 `data.livingList: Array` [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/ownerManagement/owner/detail.vue)
+      | label | value |
+      | :---: | :---: |
+      | 自住 |  |
+      | 暂住 |  |
+      | 外租 |  |
+
+## 物业管家
+  * **物业公告**
+    * 公告状态  `statusEnum: Enum`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/notify/index.vue)
+      | label | value |
+      | :---: | :---: |
+      | 草稿 | 0 |
+      | 已发布 | 1 |
+
+  * **楼管管家**
+    * 类型  `data.options: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/housekeeper/buildinMganager/index.vue)
+      | label | value |
+      | :---: | :---: |
+      | 选举 | 0 |
+      | 派驻 | 1 |
+    
+    * 性别 `genderList: Array` [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/housekeeper/buildinMganager/detail.vue)
+      | label | value |
+      | :---: | :---: |
+      | 女 | 0 |
+      | 男 | 1 |
+
+  * **报修管理**
+    * 工单状态  `status: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/repair/config.ts)
+      | label | value |
+      | :---: | :---: |
+      | 未处理 | 0 |
+      | 处理中 | 1 |
+      | 已失效 | 2 |
+      | 已完成 | 3 |
+
+    * 支付方式  `payTypeEnum: Enum`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/repair/index.vue)
+      | label | value |
+      | :---: | :---: |
+      | 微信 | 1 |
+      | 现金 | 2 |
+      | 支付宝 | 3 |
+
+## 活动管理
+  * 活动状态和总结状态  `statusData: Array`  [查看代码](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/views/event/config.ts)
+    | 活动状态 | 总结状态 | value |
+    | :-----: | :------: | :---: |
+    | 草稿 |  | 0 |
+    | 提交未开始 |  | 1 |
+    | 进行中 |  | 2 |
+    | 已结束 |  | 3 |
+    | 活动结束 | 草稿 | 4 |
+    | 活动结束 | 发布 | 5 |
 \ No newline at end of file
+# 注意事项
+
+## 登录失效
+  * 本地使用localhost预览页面，登录成功立刻失效登出
+    * 配置本地host域名或者使用chrome 83- 版本
+
+## 服务管理
+  **栏目管理**
+  > * 栏目一共分两级。
+  > * 只有创建一级栏目时，才需要选择栏目类型。
+
+  **入驻管理**
+  > * 创建物业时不需要关联小区。
+  > * 创建公益时必须关联小区，至少一个，可以多选。
+
+## 系统管理
+  **权限管理**
+  > * 不支持创建一级菜单，编辑的时候不可以修改菜单类型。
+  > * 一级菜单只可以创建二级菜单。
+  > * 二级菜单可以创建三级菜单和按钮。
+  > * 三级菜单只可以创建按钮。
+  > * 按钮不可以再创建其他权限项。
+
+  **角色管理**
+  > * 超管不可以创建角色。
+  > * 超级管理员、商务管理员、物业管理员、公益管理员这四个角色是系统角色，不可以编辑、删除。通过code字段判断。
+
+  **用户管理**
+  > * 超管可以进行所有操作。
+  > * 当前登录的人是三种管理员（商务管理员、物业管理员、公益管理员）只能初始自己的密码。
+  > * 不是超管，不是三种管理员（商务管理员、物业管理员、公益管理员），能否操作取决于权限管理中的设置。
+  > * 禁用的角色不可以被选中。
+  > * 超管只能给新用户关联商务管理员角色。
+  > * 当前登录的用户是物业管理员，表单里才有关联小区。
+  > * 查看登录成功返回值[释义](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/pinia/login.ts "释义")
+
+## 物业管理
+  **物业公告**
+  > * 已发布的公告不可以被删除、修改。
+  > * 查看详情时表单不能编辑，禁用表单会把按钮也禁用掉，所以单列出来一个返回按钮。
 \ No newline at end of file
+# 全局对象
+
+## 全局变量
+  * `$defaultImage` 坏图片占位图地址
+  * `$cnliveLogo` 项目logo地址
+  * 代码位置：[src/utils/variable.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/variable.ts)
+
+## 页面回退
+  * **`back() -> void`**
+  * 代码位置：[src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+## 表单重置 
+  * **`resetForm(formName) -> void`**
+  * 代码位置 [src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | formName | `String` | required | 表单的ref值 |
+
+## 保留小数点两位
+  * **`toDecimal2(x) -> Number`**
+  * 代码位置 [src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | x | `Number` | required | 进行保留的数字 |
+
+## 时间格式转换
+  * 时间对象、时间戳转年月日格式
+  * **`parseTime(time, cFormat) -> String | null`**
+  * 代码位置 [src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | time | `String Object Number` | optional | 待转换的时间 |
+    | cFormat | `String` | optional | 转换格式 |
+
+## 时间展示转换
+  * 时间戳转多久前
+  * **`formatTime(time, option) -> String`**
+  * 代码位置 [src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | time | `Number` | required | 待转换的时间 |
+    | option | `String` | optional | 选项 |
+
+## 表格中枚举字典filter
+  * **`globalFilters(value, groupData) -> String`**
+  * 代码位置 [src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | value | `Number String` | optional | 数字值 |
+    | groupData | `Array<Object>` | optional | 枚举字典 |
+
+## 请求参数包formData
+  * **`formDataWrapper(data) -> formData`**
+  * 代码位置 [src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | data | `Object` | required | 待提交的参数对象 |
+
+## 请求参数删除为null的
+  * **`deleteEmptyParam(params) -> params`**
+  * 代码位置 [src/utils/tool.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/tool.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | params | `Object` | required | 待提交的参数对象 |
+# 更新日志
+
+## 1.0.0 （2022-2-15）
+  首期内容上线，包含：
+  * 服务管理
+  * 系统管理
+  * 小区管理
+  * 居民管理
+  * 物业管家
+  * 活动管理
 \ No newline at end of file
+# 开发须知
+
+## 运行打包
+  * 安装：npm install
+  * 本地运行：npm run dev
+  * 测试环境打包：npm run build:stage
+  * 正式环境打包：npm run build:prod
+  * 文档本地预览：npm run doc
+
+## 目录结构
+  查看[目录结构](develop/category)
+
+
+     
+# 使用问题
+
+## 兼容性
+  * IE 不兼容（360浏览器兼容模式也不兼容）
+  * IE Edge latest
+  * Chrome v71+
+  * FireFox v65+
+  * Safari v12.1+
+  * Node v12+
+  * **推荐浏览器**
+    + [Chrome 谷歌浏览器](https://www.google.cn/chrome/ "Chrome 谷歌浏览器")
+    + [FireFox 火狐浏览器](http://www.firefox.com.cn/ "FireFox 火狐浏览器")
+    + [360浏览器【极速】模式](http://browser.360.cn/ "360浏览器【极速】模式")
+# 校验函数
+
+## 邮箱校验
+  * **`validMail(str) -> boolean`**
+  * 代码位置 [src/utils/validate.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/validate.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | str | `String` | required | 待校验的邮箱字符串 |
+
+## 手机号校验 
+  * **`validMobile(str) -> boolean`**
+  * 代码位置 [src/utils/validate.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/validate.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | str | `String` | required | 待校验的手机号字符串 |
+
+## 密码规则 
+  * 验证密码格式：8-20位密码，可以包含大小写字母、数字、特殊字符
+  * **`validPwd(str) -> boolean`**
+  * 代码位置 [src/utils/validate.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/validate.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | str | `String` | required | 待校验的密码字符串 |
+
+## 固话校验 
+  * **`tphone(value) -> boolean`**
+  * 代码位置 [src/utils/validate.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/validate.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | value | `String` | required | 待校验的固话字符串 |
+
+## 身份证校验
+  * **`checkIdcard(personnumber) -> boolean`**
+  * 代码位置 [src/utils/validate.ts](http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue/blob/dev/src/utils/validate.ts)
+
+    | keyName | keyType | keyAttr | desc |
+    | :-----: | :-----: | :-----: | :--: |
+    | personnumber | `String` | required | 待校验的身份证号字符串 |
 \ No newline at end of file
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Document</title>
+    <link rel="icon" href="/cnlive.ico" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+  </head>
+  <body>
+    <!-- 顶部导航 -->
+    <nav>
+      <a href="http://bj.gitlab.cnlive.com/cnlive_project/cnlive-community-web-vue">代码仓库</a>
+      <a href="http://test.community.web.cnlive.com/doc.html">接口API</a>
+      <a href="http://testweb.community.cnlive.com">中国网+智慧社区平台</a>
+    </nav>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        name: "中国网+智慧社区平台", // 文档名
+        nameLink: 'http://testweb.community.cnlive.com', // 标题点击跳转链接
+        repo: "",
+        subMaxLevel: 2, // 二级目录
+        auto2top: true, // 切换页面后跳到页面顶部
+        loadSidebar: true, // 加载侧边栏
+        alias: {
+          "/.*/_sidebar.md": "/_sidebar.md",
+        }, // 避免不必要的回退
+        // coverpage: true, // 启用封面
+        // homepage: 'zh-cn/guide.md', // 指定首页
+      };
+    </script>
+    <!-- Docsify v4 -->
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  </body>
+</html>
 \ No newline at end of file
@@ -5,7 +5,8 @@
     "dev": "vite --mode development",
     "build:stage": "vite build --mode staging",
     "build:prod": "vite build --mode production",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "doc": "docsify serve docs"
   },
   "dependencies": {
     "@element-plus/icons-vue": "^0.2.6",
@@ -21,7 +21,7 @@ import type { EnumArrayItem } from &quot;@/@type/module/basic&quot;
  * @returns {number} s 小数点两位
  */
  
- function toDecimal2(x) {
+ export function toDecimal2(x) {
   var f = parseFloat(x)
   if (isNaN(f)) {
     return false