「みんなのIT英語」その2

スキル

» 2010/05/14

　どうも、鹿島和郎（かしまかずお）です。

　今回も引き続き「IT英語」に関して書こうと思います。さて、今回のネタは「コメント」です。FFで隕石が降ってくる魔法のことです。最近、エンジニアライフではドラクエをネタにしたコラムが人気のようですので、張り合ってみました。

■英語のコメントが分かりにくい

　以前関わっていたプロジェクトでは、ソースコードのコメントが英語でした。細かい間違いがあるのは別に構わないのですが、意味を理解するのに時間がかかるコメントがあり、「コメントを読まずにソースを直接読んだ方が早い」という本末転倒な状況がしばしば起こっていました。

　さて、そのプロジェクトのコメントを読んでいたところ、分かりにくいコメントにはいくつかの傾向があることに気付きました。今回、それら問題があるコメントの傾向、及びそれらへの対策についていくつか述べていきます。

■傾向1：和英を使ってそれでおしまい

　「和英を使っておしまい」。これは、英語のコメントを書く際に、和英辞書で引いて出てきた単語を意味をよく調べずにそのまま使うということです。

　まったく架空の例ですが、「受け取ったデータを一時的にファイルに退避する」という文があったとします。

　ここで「退避」を辞書で引いて、evacuate なんて単語を使ってしまうと、アウトです。

○対策 1-a. 和英で引く→英和で意味を再確認

　そもそもevacuateの意味って知っていますか。実際に使う前に、もう一度「evacuate」で辞書を引いてみると、「あれ？ 何か違うな」と気付くと思います。

　和英で調べた単語（この例ではevacuate）の意味がよく分からないのなら、もう一度英和を引くことを強く推奨します。

○対策 1-b. 簡単な単語を使う

　もう1つお勧めしたいのは、「難しい単語は使わずに簡単な単語で言い換えられないかを考えてみること」です。難しい単語というのは、えてして限定した文脈でしか使えなかったりします。

　先の例ですと、「ファイルに退避する」ではなくて、「ファイルに保存する」に言い換えてみると、save って単語が思い浮かぶ方も多いと思います。

　別の例ですが、「値を取得する」を「acquire a value」と訳しているコメントを見たことがありますが、これは（意味がまったく通じないことはありませんが）かなり変です。ここでは普通に「get a value」とするべきです。

　acquireもgetもどちらも何かを「得る」という意味がありますが、getが広い意味で使われるのに対して、acquireはもっと限定された意味でしか使われません。

　動詞に関して言うと、get、set、take、put、have、go、send、receive、save、loadなどなど、そうした簡単な単語だけで99％はOKだと思います。

■傾向2 名詞を並べる

　日本語のコメントでは、以下のように名詞形でのコメントが多いと思います。

// レコード全件削除処理

　これと同じ感覚で、英語でも

// all record deletion

のように書いているコメントもよく見かけますが、これも不自然です。

○対策2 動詞を使う

　英語のコメントでは、その処理が何をするのかという「動詞」であらわすことが多いです。先の例で言えば

// Delete all the records.

と書く方が自然です。主語は「This block」、「This line」などコメント対象となっているコードですが、あえて書かなくても分かるため普通は省略します。

　あと、海外のオープンソースソフトを見てみると気付くかもしれませんが、下の例ですと（1）では動詞に三単現の"s"を付けるのですが、（2）の場所では付けないことが多いようです。

/**
 * Inserts a record to the user table. → （1）
 */
public void insertRecord(Record record) {
  // Check the parameter → （2）
  ：
  ：
}

＃文法的になぜそうなってるのかは……よく分かりません。すみません。

■まとめ

　ちょっとしたコツをつかむだけで、格段に分かりやすい英文コメントを書けるようになると思います。コツは、ここに書いた以外にもいろいろとあると思います。そして、そうした勘所をつかむのに一番いいのは、本文中でも少し触れた「オープンソースのソフトのコードを読む」ではないかと思います。

　それではまた次回。