回答編集履歴
2
補足
answer
CHANGED
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
定数として別に定義しておき、その定数名を工夫するという方法もあります。
|
|
19
19
|
|
|
20
20
|
- printf("\t.dw\t0b0");
|
|
21
|
-
という行に対し、「この.dwとは＊＊という意味である」ということを記述します。……ってこれ、アセンブラコードを生成してるんですかね? そうい
|
|
21
|
+
という行に対し、「この.dwとは＊＊という意味である」ということを記述します。……ってこれ、アセンブラコードを生成してるんですかね? 読む人にとってそういった文脈が明らかであれば、.dwなんて説明するまでもないでしょうからコメントはいらないでしょうね。
|
|
22
22
|
|
|
23
23
|
---
|
|
24
24
|
3. 意図を説明するもの
|
1
修飾をシンプルにした
answer
CHANGED
|
@@ -12,16 +12,13 @@
|
|
|
12
12
|
|
|
13
13
|
ソース中に現れる、ぱっとは意味がわかりにくい記述に対して意味を補足します。
|
|
14
14
|
|
|
15
|
-
```lang-C
|
|
16
|
-
double adj[3]={0.682,0.682,0.682};
|
|
15
|
+
- double adj[3]={0.682,0.682,0.682};
|
|
17
|
-
```
|
|
18
16
|
という行に対し、「この 0.682 とは＊＊という意味である」ということを記述します。
|
|
19
17
|
ほかに設計書や解説書があるなら、「画面設計書 5.6.2 の記載に基づき」のように根拠を示す方法もあります。
|
|
20
18
|
定数として別に定義しておき、その定数名を工夫するという方法もあります。
|
|
21
19
|
|
|
22
|
-
```lang-C
|
|
23
|
-
printf("\t.dw\t0b0");
|
|
20
|
+
- printf("\t.dw\t0b0");
|
|
24
|
-
|
|
21
|
+
という行に対し、「この.dwとは＊＊という意味である」ということを記述します。……ってこれ、アセンブラコードを生成してるんですかね? そういう文脈が明らかであれば、.dwなんて説明するまでもないでしょうからコメントはいらないでしょうね。
|
|
25
22
|
|
|
26
23
|
---
|
|
27
24
|
3. 意図を説明するもの
|
|
@@ -29,14 +26,12 @@
|
|
|
29
26
|
|
|
30
27
|
ソース中に現れる、ぱっとは意図がわかりにくい記述に対して意図を補足します。
|
|
31
28
|
|
|
32
|
-
たとえば、私は
|
|
29
|
+
たとえば、私は
|
|
33
|
-
printf("\t.dw\t0b0");
|
|
30
|
+
- printf("\t.dw\t0b0");
|
|
34
|
-
|
|
31
|
+
という行に対し、なぜ0bなのか疑問に思いました。
|
|
35
|
-
```lang-C
|
|
36
|
-
printf("\t.dw\t0x%x%x%x\n", x[0],x[1],x[2]);
|
|
32
|
+
- printf("\t.dw\t0x%x%x%x\n", x[0],x[1],x[2]);
|
|
33
|
+
でいいんじゃないか、と。そこで 「0bにしている理由は＊＊である」というコメントがあれば疑問はなくなります。
|
|
37
34
|
|
|
38
|
-
```でいいんじゃないか、と。そこで 「0bにしている理由は＊＊である」というコメントがあれば疑問はなくなります。
|
|
39
|
-
|
|
40
35
|
ほかには、その下の else 節では、単純に printf("%d,%d,%d\n",x[0],x[1],x[2]); としていますが、そんなんでいいのか? と思いました。きっと仕様書のどこかどおりに書いているんだとは思いますが、それなら「仕様書 5.6.2に従い」といった補足コメントがあるとうれしいです。
|
|
41
36
|
|
|
42
37
|
古い資料ですが、 Scott W. Ambler による「Writing Robust Java Code」の一節を紹介します。
|