五、格式

·  阅读 184
五、格式

可读性:★★★✰✰ 理解难度:★★★✰✰

概述

代码格式很重要,代码格式关乎沟通,而沟通是专业开发者的头等大事。我们的格式应该像报纸的排版一样主次分明,上下关联。

一、关联性

变量声明:尽量靠近其使用的地方,函数中的变量在函数顶部声明,类中的全局变量在类的顶部声明。

相关函数 或 概念相关:应该尽量放到一起,并且遵循自上而下的阅读习惯。

二、排版

  1. 横向字符长度不超过120个。(team中显示器屏幕很宽,可稍调大一些,主要还是为了方便沟通和阅读)。
  2. 缩进2格或者4格,团队中保持统一。

三、空格的使用

合理的使用空格,可以大大增加程序的可读性。

bad

function(line){
	let baseNum=0;
	let lineSize=line.length();
	return -baseNum+lineSize;
}
复制代码

good

function(line) {
	let baseNum = 0;
	let lineSize = line.length();
	return -baseNum + lineSize;
}
复制代码

四、团队统一规范

团队里统一一种规范,一是可以方便沟通。

还有一种情况:当两人同时修改同一个文件,本来只修改了一行代码,却因为格式不一样,发现整个文件都被修改了,增加代码对比的复杂度。

五、使用工具

现代的IDE基本都有格式化的工具。

我们团队统一使用vscode,并且都是Vue技术栈。所以团队成员统一使用一份代码格式化设置 - 《vscode最简代码格式化配置》

本文参考《代码整洁之道》(Robert C. Martin著,韩磊译)。

浙江大华技术股份有限公司-软研-智慧城市产品研发部招聘高级前端,欢迎来撩,有意向可发送简历到chen_zhen@dahuatech.com,长期有效

上一篇:四、注释

下一篇:六、对象和数据结构

分类:
前端
标签:
分类:
前端
标签:
收藏成功!
已添加到「」, 点击更改