1、排版
- 本次项目主要依赖微信开发者工具,前端wxml,wxss, Javascript, 后端Node.js依托云函数,云数据库
- 书写时利用开发工具实现层次分明的缩进(默认缩进4空格)
- 在控制语句(if, while 等)开始括号之前放置一个空格。 在函数调用和是声明中,在参数列表和函数名之间没有空格
- 在主体前放置一个空格
// good
function test() {
console.log('test');
}
// good
dog.set('attr', {
age: '1 year',
breed: 'Bernese Mountain Dog',
});
- 用空格分离操作符
- 使用单个换行符结束文件
- 在块和下一个语句之前留下一空白行
- 不要在括号、中括号内添加空格
2、注释
- 使用 /** ... */ 来进行多行注释
- 使用 // 进行单行注释。 将单行注释放在需要注释的行的上方新行。 在注释之前放一个空行,除非它在块的第一行
- 用一个空格开始所有的注释,使它更容易阅读
- 使用 FIXME 或者 TODO 开始你的注释可以帮助其他开发人员快速了解,如果你提出了一个需要重新审视的问题,或者你对需要实现的问题提出的解决方案。 这些不同于其他评论,因为他们是可操作的。 这些行为是 FIXME: -- 需要解决这个问题 或者 TODO: -- 需要被实现
3、标识符命名
- 使用 const 或者 let 来定义变量。 不这样做将创建一个全局变量。 我们希望避免污染全局命名空间
- 避免单字母的名字。用命名来描述功能
- 在命名对象、函数和实例时使用驼峰命名法
// good
const thisIsMyObject = {};
function thisIsMyFunction() {}
- 不要使用前置或者后置下划线
- 缩略词和缩写都必须是全部大写或者全部小写。
4、箭头函数
- 当必须使用匿名函数时 (当传递内联函数时), 使用箭头函数
- 如果函数体包含一个单独的语句,返回一个没有副作用的 expression , 省略括号并使用隐式返回。否则,保留括号并使用 return 语句