はじめに
開発する上で関数や変数を定義する際の話です。
実装を先にしてから名前をつけないと名前に実装が引っ張られる勘違いをしてしまいそうだったり、仮でつけた名前に満足して自己レビューで忘れてしまったりしちゃいそうで、何となく名前を明確につけるのを後回しにいがちです。
その時に「hoge」「fuga」をよく目にしますが、私は適当に「xxx」や「aaa」などと仮で定義することが多いです。
それについて最近見つけた最近のちょっとした問題を記事にします。
TODOコメントについて
TODOコメントを使用していた際に、コメントをもっとわかりやすくしたいと思い調べてみたところその問題に出会いました。
TODO 以外の記述とその意味について「こんなものもあるんだ〜」とか「今まで使ってたこういうコメントはこっちを使ったほうが適切だったな」とか思っていたところに目に入ってきた
XXX: |危険！動くけどなぜうごくかわからない。
という表の一部 これを見てタイトルのように思ったわけです。
「aaa」は少なくともいいかもしれませんが、「xxx」は辞めたいかも・・・
余談
「hoge」や「fuga」などは
意味のない名称のこと
意味を持たないということが重要
使用する際は、
それぞれ使用する順番が決まっていて最初にhogeが使われて、次にfugaかpiyo、そこからhogeraというように続く
など意外とルールがあるみたいです。