ループバックチェックで命名力を高めよう

はじめに

今回は、命名するときに使えるテクニックとしてループバックチェックを紹介します。

常に使う手法ではありませんが、役立つ場面がしばしばあるので、しっかり理解して命名作業に役立ててください。

ループバックチェックとは

ループバックチェックとは、説明→命名→説明という順番で解釈可能かを確認することです。

たとえば、音声を使ってソフトウェアを操作する機能という説明を元にループバックチェックをしてみます。

まずは命名です。
音声操作機能、音声コントロール機能、音声命令機能…色々選択肢があると思います。

次にその命名から「音声を使ってソフトウェアを操作する機能」という説明に変換できるかを検討します。

先ほどの例だと、音声命令機能が最も良さそうです。

音声操作機能だと「音声を操作する機能」だと誤解される可能性がありますし、音声コントロール機能だと「音声を制限する機能」だと誤解される可能性があります。

命名力を高める

ループバックチェックをすることにより、大事な情報が抜け落ちてしまう命名を避けることができます。

大事な情報がしっかり名前に詰め込まれていたら、コードの読み手は処理内容を誤解する危険から極力解放されます。

ただし、いつでもどこでも使っていい手法というわけではありません。

なぜなら、命名はスコープによってはある程度雑につけることが許容されるからです。

たとえば、for 文内という極めて狭いスコープを前提とするなら i という変数名も許容されます。
このように、いちいちイテレーターといった命名をする必要はなかったりします。

クラス名やパブリックメソッド名など、ある程度広めのスコープのとき特に有用な手法といえるでしょう。

まとめ

• ループバックチェックとは、説明→命名→説明という順番で解釈可能かを確認すること

• いつでもどこでも使える手法ではないが、ループバックチェックをすることで必要な情報を全て含んだ命名にすることが可能になる