不建议在项目中使用的命名方法

52 阅读1分钟

不建议在项目中使用的命名方法

不要用拼接或者三元等方式构成接口地址

比如 /api/xxxx/${isEdit ? 'edit' : 'add'}

之前一个同事问我xxx接口还在前端项目里面使用没有,我搜了一下,没搜到,然后搜索其中一部分才搜到。这种写法写的时候确实是少写了一部分,但是不方便后续维护。

不要把很多组件命名成Index

通过devtool获得组件名,然后搜索,不容易定位到具体组件。

不要把文件或组件名命名成单个单词

比如task什么的,谁能知道这个项目能维护多久,后面还有多少个task

不要import组件命名成另外一个名字在组件内部使用

比如

import Task from './Detail'

<Task />

也是通过devtool定位到组件后不容易找到组件文件

不要把全局使用的变量名或者常量定义成一个非常简单的名称

比如定义成 export const getList = '/api/xxxxxxxxxxxxxxx/xxxxx',你能想象一搜getList能搜出几十个的痛苦吗?

而且有些地方因为行长度换行了,你根本不知道是不是从那个地方导出来的,只有点进去看才知道,如下:

import { 
    getList,
    getDetail,
    getAdd,
    getEdit,
    getDelete,
} from './api'