質問編集履歴
5
内容修正
test
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
私の書いたFizzbuzzプログラムの改善点について
|
test
CHANGED
@@ -9,8 +9,6 @@
|
|
9
9
|
### 実現したいこと
|
10
10
|
|
11
11
|
|
12
|
-
|
13
|
-
- Fizzbuzzを汎用的に書く。
|
14
12
|
|
15
13
|
- 設計の適切さと使いやすさ、コードの見やすさ、ドキュメントの分かりやすさを改善したい。
|
16
14
|
|
4
内容修正
test
CHANGED
File without changes
|
test
CHANGED
@@ -96,7 +96,7 @@
|
|
96
96
|
|
97
97
|
今までドキュメントはあまり書いてこなかったので、分かりにくいと思います。
|
98
98
|
|
99
|
-
|
99
|
+
「[このサンプル上でのfizzbuzzプログラムの扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz)」と「[fizzbuzzプログラムの全般的な扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)」について記載しています。
|
100
100
|
|
101
101
|
|
102
102
|
|
@@ -104,4 +104,4 @@
|
|
104
104
|
|
105
105
|
|
106
106
|
|
107
|
-
「変数名の理解しやすさ」や「ドキュメントの見やすさ」を想像した結果が
|
107
|
+
「変数名の理解しやすさ」や「ドキュメントの見やすさ」を想像した結果が現状のリポジトリなので、経験者の方から指摘を頂き、改善したいと思い、teratailで質問させて頂きました。
|
3
内容修正
test
CHANGED
File without changes
|
test
CHANGED
@@ -12,9 +12,7 @@
|
|
12
12
|
|
13
13
|
- Fizzbuzzを汎用的に書く。
|
14
14
|
|
15
|
-
- 少なくとも 1)何番から 2)何番まで 3)何の倍数の時に 4)何を表示するか の4つは簡単に変更できるようにする。その他にも思いつけば機能追加する。
|
16
|
-
|
17
|
-
- 設計の適切さと使いやすさ
|
15
|
+
- 設計の適切さと使いやすさ、コードの見やすさ、ドキュメントの分かりやすさを改善したい。
|
18
16
|
|
19
17
|
|
20
18
|
|
@@ -88,8 +86,6 @@
|
|
88
86
|
|
89
87
|
|
90
88
|
|
91
|
-
変数名・・。変数名はいつも「意味が分かりやすく、その上で簡潔に」を意識して書いていたので、アドバイスを見た限り変数名で選考に引っかかっていてショックでした。
|
92
|
-
|
93
89
|
それぞれの変数名の意味は、[ドキュメントに記載しています。](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)
|
94
90
|
|
95
91
|
|
@@ -98,9 +94,9 @@
|
|
98
94
|
|
99
95
|
|
100
96
|
|
101
|
-
今までドキュメントはあまり書いてこなかったので、分かりにく
|
97
|
+
今までドキュメントはあまり書いてこなかったので、分かりにくいと思います。
|
102
98
|
|
103
|
-
自分では、「[このサンプル上でのfizzbuzzプログラムの扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz)」と「[fizzbuzzプログラムの全般的な扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)」について記載したつもりで
|
99
|
+
自分では、「[このサンプル上でのfizzbuzzプログラムの扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz)」と「[fizzbuzzプログラムの全般的な扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)」について記載したつもりです。
|
104
100
|
|
105
101
|
|
106
102
|
|
2
内容修正
test
CHANGED
File without changes
|
test
CHANGED
@@ -3,3 +3,109 @@
|
|
3
3
|
|
4
4
|
|
5
5
|
私は実務経験なども無く、効果的な改善方法が思い浮かばないので、経験者の方々から改善点を伺いたいです。
|
6
|
+
|
7
|
+
|
8
|
+
|
9
|
+
### 実現したいこと
|
10
|
+
|
11
|
+
|
12
|
+
|
13
|
+
- Fizzbuzzを汎用的に書く。
|
14
|
+
|
15
|
+
- 少なくとも 1)何番から 2)何番まで 3)何の倍数の時に 4)何を表示するか の4つは簡単に変更できるようにする。その他にも思いつけば機能追加する。
|
16
|
+
|
17
|
+
- 設計の適切さと使いやすさ > コードの見やすさ > ドキュメントの分かりやすさ > 設定項目の充実度 の順で改善したい。
|
18
|
+
|
19
|
+
|
20
|
+
|
21
|
+
### リポジトリ
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
[https://github.com/KazuyoshiHidaka/fizzbuzz](https://github.com/KazuyoshiHidaka/fizzbuzz)
|
26
|
+
|
27
|
+
|
28
|
+
|
29
|
+
### 個人的に足りないと思っている部分
|
30
|
+
|
31
|
+
|
32
|
+
|
33
|
+
「自分が何も知らずにこの変数名を見たとしても理解しやすいか」、「自分が初めてこのドキュメントを見たとしたら見やすいか」。
|
34
|
+
|
35
|
+
|
36
|
+
|
37
|
+
### 自己評価
|
38
|
+
|
39
|
+
|
40
|
+
|
41
|
+
- **fizzbuzzプログラムを使う部分のコードが理解しやすいと思っている。**
|
42
|
+
|
43
|
+
|
44
|
+
|
45
|
+
課題のリポジトリ内では、[このようにfizzbuzzプログラムを外から使っています。](https://github.com/KazuyoshiHidaka/fizzbuzz/blob/master/src/js/main.js)
|
46
|
+
|
47
|
+
|
48
|
+
|
49
|
+
```javascript
|
50
|
+
|
51
|
+
fizzbuzz({
|
52
|
+
|
53
|
+
numStart: numStart,
|
54
|
+
|
55
|
+
numEnd: numEnd,
|
56
|
+
|
57
|
+
numFizz: numFizz,
|
58
|
+
|
59
|
+
numBuzz: numBuzz,
|
60
|
+
|
61
|
+
textOutputFizzbuzz: textOutputFizzbuzz,
|
62
|
+
|
63
|
+
textOutputFizz: textOutputFizz,
|
64
|
+
|
65
|
+
textOutputBuzz: textOutputBuzz,
|
66
|
+
|
67
|
+
textOutputElse: textOutputElse,
|
68
|
+
|
69
|
+
callbackCommon: ({num: num, textOutput: textOutput}) =>
|
70
|
+
|
71
|
+
appendTextElementToHTMLBody(textNewHTMLElement(num, textOutput)),
|
72
|
+
|
73
|
+
});
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
fizzbuzz();
|
78
|
+
|
79
|
+
```
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
純粋なfizzbuzzをしたい時は、```fizzbuzz();```のみで使えます。
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
- **自分では、変数名を分かりやすくしたつもりでいる。**
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
変数名・・。変数名はいつも「意味が分かりやすく、その上で簡潔に」を意識して書いていたので、アドバイスを見た限り変数名で選考に引っかかっていてショックでした。
|
92
|
+
|
93
|
+
それぞれの変数名の意味は、[ドキュメントに記載しています。](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)
|
94
|
+
|
95
|
+
|
96
|
+
|
97
|
+
- **ドキュメントが分かりにくいのではないか**
|
98
|
+
|
99
|
+
|
100
|
+
|
101
|
+
今までドキュメントはあまり書いてこなかったので、分かりにくかったのかもしれません。
|
102
|
+
|
103
|
+
自分では、「[このサンプル上でのfizzbuzzプログラムの扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz)」と「[fizzbuzzプログラムの全般的な扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)」について記載したつもりでした。
|
104
|
+
|
105
|
+
|
106
|
+
|
107
|
+
### おわりに
|
108
|
+
|
109
|
+
|
110
|
+
|
111
|
+
「変数名の理解しやすさ」や「ドキュメントの見やすさ」を想像した結果がこれなので、もっとピンポイントで指摘して頂ければなと思い、teratailで質問させて頂きました。
|
1
内容修正
test
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
汎用的なFizzbuzzプログラムの改善点について
|
test
CHANGED
@@ -2,128 +2,4 @@
|
|
2
2
|
|
3
3
|
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
私は実務経験なども無く、不採用通知後に頂いたアドバイスを読んでも、課題の効果的な改善方法が思い浮かばないので、経験者の方々から改善点を伺いたいです。
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
### 課題の内容
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
- Fizzbuzzを最大限汎用的に書く。また、簡単な使い方と設計についてのドキュメントを付ける。
|
16
|
-
|
17
|
-
- 少なくとも 1)何番から 2)何番まで 3)何の倍数の時に 4)何を表示するか の4つは簡単に変更できるようにする。その他にも思いつけば機能追加。
|
18
|
-
|
19
|
-
- 言語や設定方法、表示方法は自由。
|
20
|
-
|
21
|
-
- 評価は、設計の適切さと使いやすさ > コードの見やすさ > ドキュメントの分かりやすさ > 設定項目の充実度 の順で行われる。
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
### 課題の背景
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
あくまで私が選考課題前に行われた面談で感じた、課題の背景です。
|
30
|
-
|
31
|
-
インターン先の実務では、何かのイベントのためだけに作るアプリなど、短めのプロジェクトがいくつもあるという状況です。
|
32
|
-
|
33
|
-
イベントの直前に突然仕様が変わることが多いそうなので、変更に対応しやすい汎用的なプログラムを課題にしたのだと思われます。
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
### 私が課題で提出したリポジトリ
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
[https://github.com/KazuyoshiHidaka/fizzbuzz](https://github.com/KazuyoshiHidaka/fizzbuzz)
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
### 不採用通知後のアドバイス内容
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
採用と見合わせることにした理由は、コーディングテストの「使いやすさ」や「分かりやすさ」といった観点によるものです。
|
50
|
-
|
51
|
-
「自分が何も知らずにこの変数名を見たとしても理解しやすいか」、あるいは「自分が始めてこのドキュメントを見たとしたら見やすいか」などを想像なさるとより良いものができるのではないかと存じます。
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
### 課題の自己評価
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
- **fizzbuzzプログラムを使う部分のコードが理解しやすいと思った。**
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
課題のリポジトリ内では、[このようにfizzbuzzプログラムを外から使っています。](https://github.com/KazuyoshiHidaka/fizzbuzz/blob/master/src/js/main.js)
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
```javascript
|
68
|
-
|
69
|
-
fizzbuzz({
|
70
|
-
|
71
|
-
numStart: numStart,
|
72
|
-
|
73
|
-
numEnd: numEnd,
|
74
|
-
|
75
|
-
numFizz: numFizz,
|
76
|
-
|
77
|
-
numBuzz: numBuzz,
|
78
|
-
|
79
|
-
textOutputFizzbuzz: textOutputFizzbuzz,
|
80
|
-
|
81
|
-
textOutputFizz: textOutputFizz,
|
82
|
-
|
83
|
-
textOutputBuzz: textOutputBuzz,
|
84
|
-
|
85
|
-
textOutputElse: textOutputElse,
|
86
|
-
|
87
|
-
callbackCommon: ({num: num, textOutput: textOutput}) =>
|
88
|
-
|
89
|
-
appendTextElementToHTMLBody(textNewHTMLElement(num, textOutput)),
|
90
|
-
|
91
|
-
});
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
fizzbuzz();
|
96
|
-
|
97
|
-
```
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
純粋なfizzbuzzをしたい時は、```fizzbuzz();```のみで使えます。
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
- **自分では、変数名を分かりやすくしたつもりでいた。**
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
変数名・・。変数名はいつも「意味が分かりやすく、その上で簡潔に」を意識して書いていたので、アドバイスを見た限り変数名で選考に引っかかっていてショックでした。
|
110
|
-
|
111
|
-
それぞれの変数名の意味は、[ドキュメントに記載しています。](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
- **ドキュメントが分かりにくかった?**
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
今までドキュメントはあまり書いてこなかったので、分かりにくかったのかもしれません。
|
120
|
-
|
121
|
-
自分では、「[このサンプル上でのfizzbuzzプログラムの扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz)」と「[fizzbuzzプログラムの全般的な扱い方](https://github.com/KazuyoshiHidaka/fizzbuzz#fizzbuzz-%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%A0%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)」について記載したつもりでした。
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
### おわりに
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
アドバイスを頂けたのはありがたいのですが、アドバイス通り「変数名の理解しやすさ」や「ドキュメントの見やすさ」を想像した結果がこれなので、もっとピンポイントで指摘して頂ければなと思い、teratailで質問させて頂きました。
|
5
|
+
私は実務経験なども無く、効果的な改善方法が思い浮かばないので、経験者の方々から改善点を伺いたいです。
|