简洁明了,低重构率
一、命名规范
小驼峰(第一个词的首字母小写,第二个开始首字母大写其余小写,例:fundHome)
1. 项目名称
全小写,1-3个词组,15个字符以内,用横线分割,multimodal-image-processing
2. 目录名称
2.1 常规目录:
常规目录是指用于存放项目中的常规文件,例如:图片、音频、视频等。这些文件并不直接参与项目的逻辑实现,而是作为资源被引用。
- 全小写,1词组、10个字符以内。
- 有复数结构时,要采用复数命名法。(复数结构:包含多个文件的文件夹,比如有很多 log 文件夹命名为 logs)
- 例:components,libs,imgs,bin,logs
2.2 页面目录:
页面目录是指用于存放项目中的页面文件,例如:HTML、CSS、JavaScript等。这些文件是项目的核心组成部分,负责实现页面的展示和交互功能。
小驼峰方式,限1-2个词组10个字符以内,可用缩写
例:fundHome,finIndex,home
3. 文件名称
(1) 页面入口文件:
强制使用:index.vue和index.js
(2) 组件名称:
大驼峰方式,限1-3个词组、15个字符以内,可用缩写。
例:NameCard.vue WxQuestion.vue
4. 正文中命名
类名:大驼峰,例如:FileUtils。
接口名:大驼峰,限2到3个词组20个字符以内。
方法名:小驼峰,例如:getName()。
变量名:小驼峰,例如:firstName。
常量名:全大写,后面的单词之间使用下划线连接,例如:MAX_NAME_LENGTH。
简记:
项目名 全小写(横杠)->全小写->带spring框架那层,小驼峰->小写->类和接口 大驼峰->方法、变量 小驼峰->常量全大写(下划线)