回答編集履歴
2
「変数名の末尾にsを付ける命名規則の是非」「new 演算子で生成されるオブジェクトの変数名」を追記
answer
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
### 変数名
|
|
2
|
+
|
|
1
3
|
配列(`[]`)に変更して、
|
|
2
4
|
|
|
3
5
|
- itemList
|
|
@@ -10,6 +12,8 @@
|
|
|
10
12
|
- productMap
|
|
11
13
|
- goodsMap
|
|
12
14
|
|
|
15
|
+
### 配列風の名前
|
|
16
|
+
|
|
13
17
|
> 配列風に語尾にsを付けています。
|
|
14
18
|
|
|
15
19
|
私は「末尾に `s` を付ける名前」を避けるようにしています。
|
|
@@ -22,4 +26,95 @@
|
|
|
22
26
|
バーコードはオブジェクト内に含まれており、バーコードをキーにする理由が明確でない為です。
|
|
23
27
|
バーコードをキーにする方が都合が良いのであれば、`new Map` を選択します。
|
|
24
28
|
|
|
29
|
+
### 変数名の末尾にsを付ける命名規則の是非
|
|
30
|
+
|
|
31
|
+
変数名の末尾に `s` を付ける事で複数形である事を示せますが、実際のところ、複数形の中にも**種類**があります。
|
|
32
|
+
|
|
33
|
+
```JavaScript
|
|
34
|
+
/**
|
|
35
|
+
* 末尾に s を付ける(複数形)
|
|
36
|
+
*/
|
|
37
|
+
var items = [{barcode: 1, name: "name_1"}, {barcode: 2, name: "name_2"}, {barcode: 3, name: "name_3"}];
|
|
38
|
+
var items = new Map([[1,{barcode: 1, name: "name_1"}], [2,{barcode: 2, name: "name_2"}], [3,{barcode: 3, name: "name_3"}]]);
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* 末尾にユニークな名前を付ける
|
|
42
|
+
*/
|
|
43
|
+
var itemList = [{barcode: 1, name: "name_1"}, {barcode: 2, name: "name_2"}, {barcode: 3, name: "name_3"}];
|
|
44
|
+
var itemMap = new Map([[1,{barcode: 1, name: "name_1"}], [2,{barcode: 2, name: "name_2"}], [3,{barcode: 3, name: "name_3"}]]);
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
前者は配列と `new Map` を区別できませんが、後者は区別できます。
|
|
48
|
+
「末尾に `s` を付ける命名規則」が通用するのは、次のどちらかのルールが課せられている為です。
|
|
49
|
+
|
|
50
|
+
- 複数形が一種類しか存在しない
|
|
51
|
+
- 複数形は配列であるとコーダが**決め打ち**している(この場合、`new Map` は `itemMap` のように命名して区別する)
|
|
52
|
+
|
|
53
|
+
前者はコードリーディングする人がオブジェクト初期化部分のコードまで追いかけないと、変数の中身を確認できない事を意味します。
|
|
54
|
+
後者はコーダが勝手に「複数形は配列」と決め打ちしていますが、コードリーディングする人がそのルールとは限りません。
|
|
55
|
+
複数形である以上、配列以外のオブジェクトにも `s` を付ける可能性があります。
|
|
56
|
+
例えば、DOMノードを使ったコードでも `s` を使った命名規則を見かける事があります。
|
|
57
|
+
|
|
58
|
+
```JavaScript
|
|
59
|
+
var imgs = document.getElementsByTagName('img');
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
一見、このコードは問題ないように見えますが、変数 `imgs` に格納されるのは `HTMLCollection` です。
|
|
63
|
+
DOMの複数形には `NodeList` があり、「`querySelectorAll()` で参照した変数(NodeList)」と「`getElementsByTagName` で参照した変数(HTMLCollection)」を区別できない、という問題があります。
|
|
64
|
+
両者を区別するには、次のように書きます。
|
|
65
|
+
|
|
66
|
+
```JavaScript
|
|
67
|
+
var imgCollection = document.getElementsByTagName('img'); // HTMLCollection
|
|
68
|
+
var imgList = document.querySelectorAll('img'); // NodeList
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
`HTMLCollection` は **live** ですが、`NodeList` は **live** ではない、という性質の違いもあり、名前を区別する事で性質の違いも明確となります。
|
|
72
|
+
|
|
73
|
+
ところで、DOM Interface には `Node` がありますが、複数形は `Nodes` ではなく、`NodeList` もしくは `HTMLCollection` である点に気が付いたでしょうか。
|
|
74
|
+
`Nodes` と命名すると、「Node の複数形」が一つで決め打ちされてしまう為、ユニークな単語を末尾に着ける事で両者を区別しています。
|
|
75
|
+
英語でも Interface 名、コンストラクタ名などには末尾に `s` を付ける文化はないように感じています。
|
|
76
|
+
少なくとも、私が今までに DOM の仕様書を読んだ中では、末尾に `s` を付けた Interface 名を見ていません。
|
|
77
|
+
これは後から複数形の種類が拡張されて増える可能性を踏まえて、ユニークな名前を付ける配慮があるのだと思います。
|
|
78
|
+
|
|
79
|
+
DOM 上で「単語の末尾に `s` を持つプロパティ/メソッド」には次のものがあります。
|
|
80
|
+
|
|
81
|
+
- getElement**s**ByTagName (HTMLCollection を返す)
|
|
82
|
+
- Node#childNode**s** (HTMLCollection を返す)
|
|
83
|
+
- HTMLFormElement#element**s** (HTMLFormControlsCollection を返す)
|
|
84
|
+
|
|
85
|
+
これもいろいろと「決め打ち」しているからできる事です。
|
|
86
|
+
|
|
87
|
+
- 同様の「他の複数形式(NodeList等)で返す」機能が存在しない
|
|
88
|
+
- 返り値を決め打ちしている
|
|
89
|
+
|
|
90
|
+
コーダは名前からではなく、仕様書から各APIが持つ返り値を確認する必要があります。
|
|
91
|
+
|
|
92
|
+
### new 演算子で生成されるオブジェクトの変数名
|
|
93
|
+
|
|
94
|
+
原則としてコンストラクタから生成されるオブジェクトはコンストラクタ名を反映したものであるべき、と考えています。
|
|
95
|
+
|
|
96
|
+
```JavaScript
|
|
97
|
+
var object = new Object;
|
|
25
|
-
|
|
98
|
+
var array = new Array;
|
|
99
|
+
var map = new Map;
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
ただし、`new Object`, `new Array` だけは例外で、この2つは利用用途が広範で要素の中身が重要な為、コンストラクタ名だけでは「内容を表す名前」として不十分であり、要素に準じた名前を付けるようにしています。
|
|
103
|
+
また、DOMの要素ノード系も省略形を使う事が多いですね。
|
|
104
|
+
|
|
105
|
+
```JavaScript
|
|
106
|
+
/**
|
|
107
|
+
* 厳密系 (Interface HTMLParagraphElement)
|
|
108
|
+
*/
|
|
109
|
+
var htmlParagraphElement = document.createElement('p');
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* 省略系 (tagName)
|
|
113
|
+
*/
|
|
114
|
+
var p = document.createElement('p');
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
DOMの Interface 名を基にするなら、`HTMLParagraphElement` に準じた名前にすべきですが、名前が長すぎるので `tagName` 準拠の名前にしています。
|
|
118
|
+
|
|
119
|
+
### 更新履歴
|
|
120
|
+
- 2017/11/19 13:11 「変数名の末尾にsを付ける命名規則の是非」「new 演算子で生成されるオブジェクトの変数名」を追記
|
1
補足
answer
CHANGED
|
@@ -10,4 +10,16 @@
|
|
|
10
10
|
- productMap
|
|
11
11
|
- goodsMap
|
|
12
12
|
|
|
13
|
+
> 配列風に語尾にsを付けています。
|
|
14
|
+
|
|
15
|
+
私は「末尾に `s` を付ける名前」を避けるようにしています。
|
|
16
|
+
理由は「**item と items を一目で見分けられないから**」です。
|
|
17
|
+
`item` と `itemList` なら違いが明確になります。
|
|
18
|
+
|
|
19
|
+
> ただ、名前的に配列と見分けがつかないので、悩んでおります。
|
|
20
|
+
|
|
21
|
+
個人的には配列のように見えるので、配列を使いたくなります。
|
|
22
|
+
バーコードはオブジェクト内に含まれており、バーコードをキーにする理由が明確でない為です。
|
|
23
|
+
バーコードをキーにする方が都合が良いのであれば、`new Map` を選択します。
|
|
24
|
+
|
|
13
25
|
Re: fjaiofjawiefjaw さん
|