search

chirimen-oh / chirimen.org

Tutorials for CHIRIMEN
https://tutorial.chirimen.org/
Mozilla Public License 2.0
3 stars 7 forks source link

サンプルコードの変数名をより具体的にすべきではないか #58

Open dynamis opened 4 years ago

dynamis commented 4 years ago

変数名は GPIO の何番ポートでも I2C の何番ポートでも全て port 変数になっていたりする。JavaScript 経験者としては必要に応じて変数名を書き換えるのは当たり前で平気だが、JavaScript 初学者がコピペして組み合わせるときには分かりにくい (塩尻での WIMC にて gpio ポートを i2c ポートで上書きする人が続出した)。

なるべく初学者が困ることが少なくなるようにするためだけでなく、実際ちゃんとしたエンジニアが書くコードだとしても変数名からその中身が自明なコードにすべきものであり ledPort や switchPort など、複数同時利用時以外も用途の分かるコードを最初から利用するようコードを書き換えていくべきだと思った。

dynamis commented 4 years ago

そもそも const 使ってればエラーが表示されるよって話がご尤もという感じで、変数名を変えると同時に const にした方が良さそう。

const と var と let との違いを教えることになるが、原因不明のエラーに長い間悩ませるよりマシな印象。1 人だけならともなく、20 数名の全員ではなく一部の人が組み合わせコードにトライしている中で 2-3 名が同じミスをしているところを見ると、2 割くらいの確率で変数名上書きしちゃうということなので。。。