Murga

個人的に言いたいコト・主張・気持ち。

連番は使い始めた時点で終わり

変数名やブランチ名に連番を使い始めた時は、命名を真剣に考えていない。本当にその「1」「2」という数字・順序に意味があるのか、99% はその数字を付ける考え方が間違っている。

似たようなオブジェクトを別名にするなら、連番で区別するのではなく、それぞれのオブジェクトの意味を考えること。

変数名 user1user2 ではなく、更新前のユーザ情報を退避しているなら beforeUpdateUser にして、更新処理に使うユーザ情報を updateUser とする、とか。英文法はともかく、最低限英単語からそのオブジェクトの違いが推測できるようにする。

他にも、たとえば Git でドキュメントを修正する時、章立てやページ番号を含んだ feature ブランチを作って作業されても、中身が分からない。feat/section1feat/section2 ではなく、feat/userGuideSectionfeat/troubleshootingSection など章のタイトルを使う。これによりページ番号が変わった場合もテーマ別にブランチの範囲が閉じられるので分かりやすくなる。

連番を使い始めた瞬間、そのコードや文章は読み手のことを無視していて、自分のことしか考えていない成果物に成り果てる。自分が理由なく付けた連番で、読み手は存在しない答えを推測することになり、負担・コストでしかない。

結局は読み手に意識が向いているかどうか、である。プログラミングのスキルでも知識の量でもなんでもなく、「これって伝わるかなぁ、誤解されるとしたらどういう風に誤解されるかなぁ」と頭が先々のことに回せているかどうかである。