スポンサーサイト

上記の広告は1ヶ月以上更新のないブログに表示されています。
新しい記事を書く事で広告が消せます。

英語のコメント

プログラム中のコメントの書き方。
プログラマにとって、最も代表的な議論の種ではないでしょうか。

コメントの書き方に関しては宗教論的な側面もありますが、あきらかにやってはいけない書き方というのも存在します。

そのようなコメントはソースコードの可読性をさげるだけでなく、オリジナルソース変更時にわけのわかならいバグを誘発したりします。
今回はそんなコメントについての話として、「英語コメント」をとりあげます。

プロジェクトによっては「コメントは英語」と決まっているところもあるかと思います。しかし、英語コメントは非常に危険な側面を持っています。

・英語がわからないのでコメントをかかない。あるいは極端に少ない。
・英語が間違っていて理解ができない。あるいはウソになっている。

前者はまだましですが、後者は悲惨です。こんなコメントならないほうがはるかに良いでしょう。

そもそもなぜ英語なんでしょうか?
プロジェクトに外国人がいるとか海外でも使用するというならわかりますが、あきらかに日本でしか使わない、日本人しか読まない、というものまで英語になっていることがあります。これは無意味です。

プログラマが英語が苦手な場合は、初めから日本語で書いた方が保守性ははるかにあがるでしょう。無意味な規約やプライドなんかは捨てて、素直に日本語でコメントを書きましょう。

【関連リンク】
プログラミングの禁じ手Web版 C言語編 - コメントに関するパターン

コメント

非公開コメント

本のおすすめ

4873115655

4274065979

4822236862

4274068579

4822255131

B00SIM19YS


プロフィール

  • Author:proger
  • 組み込み関係で仕事してます

ブログ内検索

上記広告は1ヶ月以上更新のないブログに表示されています。新しい記事を書くことで広告を消せます。