開発ツール

コードにコメントは必要か--否定派と肯定派、それぞれの意見

コードにコメントを書き込むと煩雑になるという意見がある一方で、コード自体では表現しにくい情報を提供するために必要という意見もある。コメント賛成派と反対派のそれぞれの意見を考える。

 コードにコメントを付けるべきだろうか。答えはもちろん、イエスである。と同時に、ノーでもある。冗談はさておき、「まずはコメントに頼らなくても理解できるように、なるべくシンプルなコードを作成するように努める。これ以上分かりやすいコードは書けないというところまで到達してから、コメントを書き始めるべきだ」。これはJeff Atwood氏が2006年に記した内容だが、当時と同様に、現在の状況にも当てはまる。むしろ現在の方がもっと、真剣に捉えるべきかもしれない。

コメント否定派の意見

 このトピックを持ち出すと必ず(そしてすぐに)、コードをコメントで煩雑にすべきでないと主張し、その理由を述べる人が現れる。コメント反対派の代表的な意見の1つが、コメントはコードのシグナルにとってノイズとなる、というものだ。「優れたコードとは自己文書化されたコードである」という言葉があり、コメントの追加は時として、粗悪なコードを覆い隠してしまい、プラスの効果が得られないことがある。Bennett Garner氏は次のように書いている

編集部おすすめの関連記事

残り本文:約1705文字 ログインして続きを読んでください。

「開発ツール」で読まれている記事

TechRepublic Japanで人気の記事

編集部オススメ

トレンドまるわかり![PR]

財務・経理
人事・労務
マーケ・営業
購買・調達
生産・製造
データ分析
コミュニケーション
通信・通話
文書・コンテンツ
PC・モバイル
新興技術
ITインフラ
クラウドサービス
OS・ミドルウェア
開発
開発ツール
開発支援
ノンプログラミング開発ツール
データベース
運用
セキュリティ

ホワイトペーパーランキング

  1. なぜ、2021年にすべてのマーケターが「行動経済学」を学ばねばならないのか?
  2. SIEMとEDRが担うべき正しい役割とは?企業のセキュリティ部門が認識しておくべき適切なツールの条件
  3. デザインシンキングによるAIと課題のマッチング!現場視点による真のデジタル改善実現へ
  4. なぜ成長企業の経営者はバックオフィス効率化に取り組むのか?生産性を高めるための重要な仕組み
  5. Microsoft 365を利用する企業が見逃す広大なホワイトスペースとは?

Follow TechRepublic Japan

このサイトでは、利用状況の把握や広告配信などのために、Cookieなどを使用してアクセスデータを取得・利用しています。 これ以降ページを遷移した場合、Cookieなどの設定や使用に同意したことになります。
Cookieなどの設定や使用の詳細、オプトアウトについては詳細をご覧ください。
[ 閉じる ]