Home > プログラミング > コメントに愛を

コメントに愛を

可読性を上げるためにコメントを入れることは当然なのですが、ただコメントを書くだけでなく、書き方にも工夫してみようかという試みです。

例えば、


// 社員登録
社員マスタ.Save();

なんてコードがあったりします。
まあ、よくあるコメントですね。

では、この例ではどうでしょうか。


// 入力データを社員テーブルに登録します。
社員マスタ.Save();

少しコメントに温かみがあるような気がしませんか。
なぜかというと、文章で説明しているからです。
例えばコメントが一切書かれていないとき、コードの意味を作った人に聞いてみるとします。

「これってどういう意味ですか?」
「社員登録」

こう言われると、意味は分かりますがなんか気分良くないですよね。
それでは、次のケースではどうでしょうか。

「これってどういう意味ですか?」
「入力されたデータを社員テーブルに登録しています。」

こっちの方が普通の会話ですよね。
コメントというのは、自分以外の人がコードを見たときにきちんと理解できるように入れるものですが、理解できればそれで良いというものではなく、優しく語り掛けてあげるような書き方をすることで読む方も気分よく仕事をすることができるようになります。
「あいつのコード読みたくないんだよなあ」と思いながら仕事をするより、「あいつのコードを読むのは面白い」と思われた方が作業効率も違ってきます。

この僅かな気持ちの差は、長い期間で大きな差となってくるでしょう。
面倒くさいかもしれませんが、「ですますコメント」をやってみてはいかがでしょうか。

ちなみに、弁慶フレームワークは「ですますコメント」で書かれています。
弁慶フレームワークの半分は愛情で作られています(汗)

Comments:0

Comment Form

Trackbacks:0

TrackBack URL for this entry
http://magicbox.sakura.ne.jp/mt/mt-tb.cgi/358
Listed below are links to weblogs that reference
コメントに愛を from 爆裂!C#野郎

Home > プログラミング > コメントに愛を

Search
Feeds
Tag Cloud
Recommend

SQLパズル 第2版 プログラミングが変わる書き方/考え方
SQLパズル 第2版 プログラミングが変わる書き方/考え方

ソフトウェアアーキテクチャ―ソフトウェア開発のためのパターン体系
ソフトウェアアーキテクチャ―ソフトウェア開発のためのパターン体系

ITアーキテクト vol.1
ITアーキテクト vol.1

オブジェクト指向における再利用のためのデザインパターン
オブジェクト指向における再利用のためのデザインパターン

増補改訂版 Java言語で学ぶデザインパターン入門
増補改訂版 Java言語で学ぶデザインパターン入門

増補改訂版 Java言語で学ぶデザインパターン入門 マルチスレッド編
増補改訂版 Java言語で学ぶデザインパターン入門 マルチスレッド編

J2EEデザインパターン
J2EEデザインパターン

アンチパターン―ソフトウェア危篤患者の救出
アンチパターン―ソフトウェア危篤患者の救出

世界でいちばん簡単なネットワークのe本―ネットワークとTCP/IPの基本と考え方がわかる本
世界でいちばん簡単なネットワークのe本―ネットワークとTCP/IPの基本と考え方がわかる本

Return to page top