読者です 読者をやめる 読者になる 読者になる

日々常々

ふつうのプログラマがあたりまえにしたいこと。

メソッド名を日本語にする話

Javaでもメソッド名とか*1に日本語が使えます。使えない文字*2もありますけど、とりあえず置いておきます。

public void あいうえお() {
    // なんか書く
}

流石にプロダクトコード*3で日本語メソッド名などを使う事はまずありませんが、テストコードで書くと言う話は結構聞く所ですし、それなりの効果もあります。

@Test
public void あの条件であれやったらああなると良いな() {
    // なんかテスト
}

日本語メソッド名は、いちいち日本語入力に切り替えないといけないとか、呼ぶときは面倒だったりしますが、テストメソッドのように呼び出しを書かないものなら特に問題無いと思います。
日本人なので日本語で何かを書くと、それなりの意味が自然に入ると思います。少なくとも日本語で書けば、テストメソッド名が「hoge」とか「test」とかになる事はありませんし、「テスト」なんてものにもしないと思います。元々はっきりしていれば全く考えずに自然に書けるでしょうし、悩むならばそれは必要な悩みだと思います。


そんなわけで私もだいたいテストメソッド名は日本語で書くのですが、最近頭を悩ませる事が一つあります。
Javadocに書く事が無くなるんです。
昔はJavadocに条件とかをつらつらと書いていました。それがメソッド名でだいたいわかるようになるので必要無いんです。メソッド名と同じになってしまうと意味がありません。「なら書かなければ良いじゃない」となるのが自然なのですけど、それだとEclipseさんがお怒りになります。怒りを鎮めたまえ、と警告を消してしまうと、それはそれで微妙ですし、かといって「警告を消すためだけのコメント」なんて書きたくないですし。


どうしたもんですかね。

*1:クラス名とかにも使えるけど、とりあえず置いておく。

*2:JavaSE 7でメソッド名に使えなくなった文字 | HOS Co.,Ltd.など

*3:実際に本番環境で動かすもの