回答編集履歴
1
インデントが消えていたため、可読性向上のための修正
answer
CHANGED
|
@@ -1,33 +1,43 @@
|
|
|
1
1
|
20年近く業界に居る者です。
|
|
2
|
-
個人的にですが、
|
|
2
|
+
個人的にですが 、
|
|
3
|
+
|
|
3
|
-
書くべき
|
|
4
|
+
**書くべき**
|
|
5
|
+
|
|
4
6
|
と思っています。
|
|
5
7
|
流石に全Stepに書けというのは異常だと思いますが、
|
|
6
|
-
処理まとまりのブロック毎に
|
|
8
|
+
処理まとまりのブロック毎に、
|
|
7
|
-
|
|
9
|
+
- どんなこと(目的)を
|
|
8
|
-
|
|
10
|
+
- どう(処理)するために
|
|
9
|
-
|
|
11
|
+
- どう(アプローチ/実現)しているか
|
|
12
|
+
|
|
10
13
|
といった説明は書いておいたほうが安全であるし、
|
|
11
14
|
可読性/保守性が上がると思うためです。
|
|
12
15
|
|
|
13
|
-
また、過去に参画したプロジェクトで散見されたデグレードなどから
|
|
16
|
+
また、過去に参画したプロジェクトで散見されたデグレードなどから、
|
|
17
|
+
|
|
14
|
-
設計は合っているのに、実装が間違っている
|
|
18
|
+
**設計は合っているのに、実装が間違っている**
|
|
15
19
|
ということをも間々見受けられ、レビューすり抜けも見てきたので、
|
|
20
|
+
|
|
16
|
-
設計書に記載の日本語を最初にコメントに打ち込んでおき、
|
|
21
|
+
**設計書に記載の日本語を最初にコメントに打ち込んでおき、**
|
|
22
|
+
|
|
17
|
-
それをもとに実装する
|
|
23
|
+
**それをもとに実装する**
|
|
24
|
+
|
|
18
25
|
という概念も安全考慮上有効だったため、当たり前なことも必要と考える範囲で明記すべきだと思います。
|
|
19
26
|
|
|
20
|
-
他にも
|
|
27
|
+
他にも、
|
|
28
|
+
|
|
21
|
-
if (true == flagX)
|
|
29
|
+
**if (true == flagX)**
|
|
30
|
+
|
|
22
31
|
などの場合、
|
|
23
32
|
flagXが何を指し示しているかはコード辿らないと分からないし、
|
|
24
33
|
引数で渡されている場合、本当に意図したものが渡されてるかも分からないし、
|
|
25
34
|
やはり可読性の面では
|
|
35
|
+
|
|
26
|
-
flagX(設定の〇〇)がtrue(利用可)となっている場合
|
|
36
|
+
**flagX(設定の〇〇)がtrue(利用可)となっている場合**
|
|
37
|
+
|
|
27
38
|
など補記すべきかなと思っています。
|
|
28
|
-
|
|
39
|
+
変数名もっと分かりやすくしろよってのでも良いと思いますが、派生開発でflag乱立とか見たこともあるので、
|
|
29
|
-
ただ、派生開発でflag乱立とか見たこともあるので、
|
|
30
|
-
|
|
40
|
+
変数名信じるなってのもある気がします。。。
|
|
31
41
|
|
|
32
42
|
総じて、PG/SEがみんな自分と同じ読解力/設計思想/概念知識(FWやデザインパターン)を持ち合わせているわけではないので、
|
|
33
43
|
デファクトかどうかは関係なく、コメント推奨派です。
|