コメントの大切さ。

/ 流通システム部　

大島 (2009年4月 9日 13:19)
流通システム部

最近、何度かプログラムの修正をする機会があり、
私が作成したものを修正することも、他の人が作成したものを修正することもありました。

自分自身で作成したプログラムであれば、処理の流れや内容などは既にわかっているので、
どこを修正したら良いかをあまり時間を掛けずに見つけることが出来ます。
しかし他の人が作成したプログラムの場合にはそうはいきません。

その時に活躍するのがコメントです。

先輩方に「プログラムを書く際にはきちんとコメントを入れた方が、
後で他の人が読んでも読みやすい」と教えていただきましたが、
実際に他人のプログラムを修正したことでコメントの重要性を実感しました。

コメントがきちんと書かれていると、
どんな処理を行っているのか一目で判り、修正箇所をすぐに見つけることが出来ます。
逆に、コメントが書かれていない場合には、
どこで何の処理を行っているのか探さなければならず時間が掛かってしまいます。

コメントをきちんと書く事によって、作業時間を短縮することが出来るのです。

コメントの重要性を感じてからは、私は以下の事に気をつけてコメントを書くようにしています。
　・なるべく細かくコメントを付ける。
　・同じ処理を行っている場合には、コメントもそこに書いてあるものと同じ文にする。
　・処理内容と異なるコメントは残さない。
　・他の人とコメントの書き方を合わせる。
　
コメントがあることによってプログラム自体が読みやすくなりますし、
どう書いたら見やすいかとインデントなどにも気を使うようになります。

十人中十人が読みやすい、と感じるプログラムを目指して精進していきたいと思います。

「システム開発ブログ」へのコメントやご意見等ありましたら、ファンページまでお願いします。 Facebook のファンページ

[PR]
他社のシステムも直します。資産を活かしてシステムリフォーム

システムのトラブル解決を承ります。すぐにシステムリフォームを体験できます

システム開発のアイロベックス（東京都新宿区）

/ 流通システム部　  Tweet シェア

システム開発ブログ

最近の記事

カテゴリー

部署

月別アーカイブ

以前の部署別ブログ

検索

システム開発専用サイト

Windowsフォルダーアクセス権限確認ツール

Webとリアルをつなぐコンテンツマネージメントシステム

Twitter公式アカウントに認定されています