1、项目命名
采用小写 + 短横线的方式命名,如bill-manage
2、目录命名
采用小驼峰方式命名,如有复数结构时(此文件夹包含文件夹),采用复数命名法,如:components、assets
3、js、css、less、sass等文件命名
采用小驼峰命名规则(第一个单词首字母小写,后面的单词首字母大写),如:userInfor.js、admin.css
4、vue组件命名
采用大驼峰方式命名(首字母大写),如:SimpleCard
5、 标签样式命名
全部小写,单词与单词之间采用“-”链接,如:.main-nav { }
6、常量和变量命名
常量:单词全部大写,单词与单词之间采用“-”连接,用const定义。如:const BASE_URL = ‘http://baidu.com’
变量:采用小驼峰方式命名(第一个单词首字母小写,后面的单词首字母大写),如:keywordList
7、图片命名
采用小写+下划线的方式命名,格式:图片大类_图片描述
(1) 前半部分是指图片的大类,如广告、标志、菜单、按钮等
banner:代表放置在页面顶部的广告、装饰图案等长方形图片
logo:代表标志性的图片
button:代表在页面不固定的位置,且带有链接的小图片
menu:代表在某个位置连续出现,性质相同的链接、栏目的图片
pic:代表装饰用的照片
title:代表不带链接,表示标题的图片
(2) 后半部分是指描述性质的英文单词
(3) 举例:logo_national、pic_people
8、注释规范
(1) 方法注释
@description 方法描述
@param {参数类型} 参数名称 参数描述
@param {参数类型} 参数名称 参数描述
@return void/{返回的文件类型} 描述信息
/**
* @description 获取验证码
* @param {string} timeStamp 时间戳
* @return {string} 验证码图片地址
*/
export const veriCode = (timeStamp) => {
return $https.get("/sys/randomImage/" + timeStamp);
};
(2) 文件注释
/**
* @FileDescription 该文件的描述信息
* @Author 作者名字
* @Date 文件创建日期
* @LastEditors 最后更新作者
* @LastEditTime 最后更新时间
*/