Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

添加变量命名建议及禁止事项 #13

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

添加变量命名建议及禁止事项 #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a59344e
add more variable naming suggestion
coolzjy Oct 28, 2015
bd944e8
add a forbidden item
coolzjy Oct 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions javascript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,29 @@ var foo_bar = 'hello eleme';
var fooBar = 'hello eleme';
```

尽可能做到见名知意：

```js
// 不推荐
var item;
var list;

// 推荐
var selectedNode;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

局部变量确实可以直接 item，甚至 i，要不然太长了反而难以阅读。。

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

我认为相对于简短而没有具体含义的命名，相对长一些但表意更明确的命名反而更有助于代码阅读。

如果只声明 item，不通过上下文根本难以知晓变量保存的内容。但如果声明 userInputStr 这样的变量名，即使没有上下文语句也可以很明确的知道该变量保存的是用户输入的内容。

关于命名过长的问题，可以通过单词缩写规则进行规避(如 i18n addr msg btn 等)。

另外对于一些特定环境中表意明确的变量则可以尽量缩减命名，比如循环变量 i。

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i 就是 index 的缩写嘛

var selectedNodeList;
```

数组的命名使用名词的复数形式或 List：

```js
// 不推荐
var fooBar = [foo, bar];

// 推荐
var fooBars = [foo, bar];
var fooBarList = [foo, bar];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

```

### 常量大写

```js
Expand Down Expand Up @@ -331,6 +354,7 @@ Promise.resolve()

* 禁止使用 `eval`，非用不可时可以使用 `Function` 构造器替代。
* 禁止使用 `with` 语句。
* 禁止使用 `for in` 循环遍历数组。
* 禁止在块作用域中使用函数声明语句。

```js
Expand Down