OMS Vue3命名规范

一、文件/文件夹命名规范

文件夹命名

使用小写字母和连字符（短横线）命名目录，使用有意义的名称来描述目录的内容和用途。例如 assets、components、 例如：弹窗文件夹：模块名-modal。

文件命名

1、文件名应全部小写，并且以横线（-）分隔单词

使用小写字母和连字符（短横线）命名文件，使用有意义的名称来描述文件的内容和用途。例如： app.vue、home-page.vue、my-component.vue。文件名中应该只包含单词和横线，不要使用驼峰命名法，这样有助于提高以及解决跨平台兼容问题。

    |-- components
        |-- my-component.vue
        |-- my-another-component.vue

组件命名

1、通用组件：

统一使用大写字母开头的(PascalCase)命名规范（当文件夹下只有一个文件时用index.vue命名，多个文件时以功能命名）

全局公共组件：/src/components示例
- [components]
  - [Breadcrumb]
    - index.vue
  - [Hamburger]
    - index.vue
  - [SvgIcon]
    - index.vue
  - [CarrierMgt]
  	- CarrierSelect.vue
  	- CarrierXxx.vue

组件名应该使用大驼峰命名法来命名

 export default {
        name: 'FooterPage'
    }

2、业务内组件：

组件文件名称使用小写字母和连字符（短横线）命名文件。例如：carrier-vendor-edit-modal。

功能组件：/src/view事例
- [views]
  - [carrier-mgt]
  	-[carrier-vendor]
  		-[carrier-vendor-edit-modal]
  			-carrier-vendor-edit-modal.vue
  		-index.vue

类文件名

类文件在是各种接口入参和返参、页面上数据模型所对应的对象。类文件名同组件名，类名使用 PascalCase（大驼峰命名法），例如：CarrierInfoInqDto

二、变量命名规范

代码中的变量命名应该遵循****小驼峰命名法****，例如：lotInfo、equipemntInfo。变量名简短且望文生义，容易联想等特点，且不可为简短而丧失了变量名的意义。

常用普通变量命名

（1）boolean变量为“xxxFlag”，例如：disableFlag。

（2）数组变量为“xxxList”，例如：lotList、eqpList等。

（3）事件变量为“xxxEvent”, 例如：clickEvent、btnClickEvent。

（4）文本标签标量为“xxxLabel”，例如：lotInfoLabel。

（5）按钮变量为“xxxBtn”, 例如：confirmBtn。

（6）数字变量为“xxxNum”

表格变量命名

（1）表格中的行需在最后包含“xxxxRowsList”的关键字，例如：eqpRowsList.其含义为设备行数组。

（2）字段列数据为“xxxColmunsList”关键字，例如：eqpColmunsList。其含义为设备列数组。

（3）表格选中对象为“selectxxx”，例如：selectEqp。其含义为设备表格选中对象。

静态值变量命名

静态值变量是指代码中常用的只读变量，文件constDef.ts统一管理全局变量，文件xxx-const.ts管理局部功能性变量。局部变量命名方式遵循以下：

（1）表格字段静态变量，遵循：功能名（全大写）+“List”,例如： POSTPROCESSING_List 。

（2）局部变量为“ConstDef”+功能名{static readonly值名=值}例如：ConstDefPostActionList{static readonly delete=’delete’};

全局变量遵循如下：ConstDef{static readonly OMS功能名_变量名 =‘变量’}，例如：ConstDef{static readonly OMS_EQP_Category_WaferBonding = “Wafer Bonding” }

其他常用变量命名

componentType：为该功能类型；

modalHeader：弹框头部显示字符串；

opeMemo: 操作记录的字符串；

三、方法命名

代码中方法命名遵循****小驼峰命名法以动词开头****，例如：第一个函数首字母为小写，函数名中的每一个逻辑断点都有一个大写字，“doRequstEqpInfo()”等。同样应该遵守简单且明了的命名方式。

事件方法命名

行为+类型,例如：confirmBtn()、clickLable()、clearInput()等

请求方法命名

根据具体的业务场景和功能，给接口请求方法命名，使其能够准确描述所执行的操作，例如： // 获取Lot详情 getLotDetail(productId)

行为方法命名

行为方法即在代码中被其他方法调用。遵循：动作+名字，例如：canDelete()、isSelectItem()等方法作为判断之意。

弹框的方法命名

遵循：弹框名字+“Modal”，例如：postProcessingListModal()。

跳转方法命名

遵循：“goto”+页面名称，例如：gotoLotInfo()。

四、注释命名规范

书写注释是编写代码非常的重要的步骤，书写注释采用第三人称视角，用词简单，以标准的白话文为主，不得随意使用任何表达人类情绪的用词，秉承****简单、高效、实用****的书写原则。

变量注释

变量注释使用单行注释：“//”，主要是数据项的描述、数据类型和初始值等信息，例如：tab=[];//路由信息

方法注释

行为方法注释/事件方法注释，遵循：事件发生源类型 + 事件类型 + 功能描述，例如：描述功能作用，例如：/*** 刷新功能*/refresh(){………}/*** 点击 按钮 清除*/clearBtn(){………}

请求方法注释

遵循：请求 + 接口名，例如：/*** 请求 接口名：/post/post_action_list/inq*/postActionListInq(){………}***

弹框方法注释

遵循：弹框 +事件发生源类型 + 弹框名，例如：/**按钮 弹框 Post Process Additional Information/postProcessAdditionalInfoModal (){………}

跳转方法注释

遵循：跳转 + 跳转界面名，例如：/跳转 lot information界面/gotoLotInfo(){………}

TODO 注释

用来标记需要完成的任务或待办事项。在注释中描述任务，并指明需要处理任务的地方。例如：// TODO: 添加表单验证逻辑

生命周期钩子函数注释

用于描述每个钩子函数的触发时机和用途。例如：/*生命周期钩子：组件创建完成时触发执行相关逻辑/created() {………}

文件类型的注释

是指在文件创建过程中，需要简单描述文件功能性，创建人、创建时间。统一注释类行为

类文件注释类

文件是指.dto.ts类型文件注释格式统一添加Description：业务功能 xxxxx

接口类文件注释

接口类文件是指.dto.ts类型文件注释格式统一添加Description：接口地址：/post/cim_object_list/inq 组件文件注释注释格式统一添加Description：组件简单介绍