2008年4月11日金曜日

ボイラープレート

Distinctive Features Of SQLite」によればSQLiteの特長のひとつとして「Readable source code」つまりソースコードが読みやすく書かれてあって関数や変数に対するコメントも役に立つ内容のものになっているということがあるそうですが、その最後に

Boilerplate commenting is omitted.

とあり、この"boilerplate"というのがわからなかったので辞書をひきました。

ボイラーという響きから、グツグツ煮えたぎった感じ、グダグダ長々と書いてあるけど何が言いたいんだか結局わからないようなコメント。そんな予想をしてたんですが。

最初にためしたgoo 辞書の英和辞典ではひっかからず。

次にYahoo!辞書で"boilerplate"を検索したところ「画一的な言葉」と出てきました。なるほど。

たしかに

/**
 * hogeNameを取得する。
 * @retrun hogeName
 */
public String getHogeName()
{
    return this.hogeName;
}
とかって(まぁSQLiteはJavaじゃないけど)無茶苦茶ありがちですな。いわば同義反復の嵐。

で、SQLiteのソースコードではそういうおざなりなコメントはバッサリ斬り捨ててありますよと。

0 件のコメント: