LoginSignup
1
0

More than 5 years have passed since last update.

コメントアウトについての賛否

Last updated at Posted at 2018-03-08

コメントアウト賛成派の意見

  • 過去のコードが一目瞭然
  • 過去の変更履歴がないと何を修正したのかわからない

コメントアウト反対派の意見

  • コメントは今コードが動いている理由を説明するものであり、過去にコードが動かなかった理由を説明するものではない
  • コードを読む理由は「現在の動作を理解するため」あるいは「現在何が間違っているのかを発見するため」が第一の理由であって、「過去に何があったのか」を紐解くのはそれらが解決した後の作業だから。
  • 変更履歴はSCMが保持しており、かつ変更履歴が正常に機能するなら変更理由と変更内容は理解可能である。
  • 変更理由(変更の動機)はBTS,ITS等により厳密に管理される必要があり、変更理由(変更の動機)に対する作業内容も厳密に管理されるべきだから。
  • 適切なコメントはコードの理解を助けるが、そうでないコメントはコードの理解を妨げる

コメントアウト賛成派の意見があればどうぞ。

1
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
0