前端代码规范
title: 前端项目介绍 date: 2022-03-18 09:52:33 permalink: /pages/3ba9g2/ categories:
- docs
- 前端军刀
- 框架介绍 tags:
- author: name: ABpasser
# 爽客邦 ES Hybrid APP 开发-前端代码规范
# 文件编码格式
- UTF-8
# 文件命名
# html 文件/夹命名
- 全小写以-分隔单词
"user-login.html";
1
# html 文件夹命名
- 全小写以-分隔单词
"user-login.scss";
1
# JS 代码命名
# 环境常量
- 全大写以_分隔单词
const PRODUCTION_ENVIRONMENT = "develop";
1
# 常量
- 大驼峰命名
const MerchantNo = 6230214578451254112;
1
# 变量
- 小驼峰命名
let merchantNo = "6230214578451254112";
1
# 函数命名
- 小驼峰命名
const stockFormatter = (num) => {
return num * 2;
};
1
2
3
2
3
# 组件
- 小驼峰命名
merchantCard.vue;
1
# 注释
- 注释应多用于某段代码为什么存在
- 强调代码的目的，用途和背后的逻辑
# 单行注释
- 单行注释放在注释代码上方，如果单行注释不是代码块的首行，需在注释前面空一行
// 库存格式化，用于将当前库存翻倍显示
const stockFormatter = (num) => {
return num * 2;
};
1
2
3
4
2
3
4
# 多行注释
- 多行注释 /**... */ 用于文件说明，类型说明，参数说明
/**
* 用于将当前库存翻倍显示
* num: 当前库存数量
* */
const stockFormatter = (num)=>{
return num * 2;
};
1
2
3
4
5
6
7
2
3
4
5
6
7
- 多行注释 //... 用于代码块多行解释
// 库存格式化
// 用于将当前库存翻倍显示
const stockFormatter = (num)=>{
return num * 2;
};
1
2
3
4
5
2
3
4
5
# 字符串格式
- 字符串符号应为""
const SnNo = "62312012452123654"
1