0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

ソースコードのコメントって必要なの?

Last updated at Posted at 2019-06-21

ソースコードのコメントについて必要なのか考えてみました。

僕自身、コメントに関しては書いてる方で、
指導して頂いた先輩たちにも「コメントを書いてね」と言われてきました。

それに対して、疑問も浮かばなかったけど、
実際の動作に影響がないのに何で書いているんだろうと振り返りました。

何でコメントを書いていたのか

僕自身、そこまで生産性のあるプログラムを書けている訳ではないため、
機能を把握して貰える様に書いていました。
説明書のようなものです。

何で説明書が必要だったのか

複雑なソースコードを使用するには説明書が必要ですよね!

ん?

(つд⊂)ゴシゴシ
 
(;゚д゚) ・・・

気付かなかったけど
それって単純にソースコードが悪いんじゃ...

どんなソースコードだったらコメントはいらないの?

適切な名前で、他に依存しない、役割が明確ならばコメントは不要
ついでにソースコードの質も上がるのではないかと思います(本来こっちが本質ではありますが)

理想は可能な限り書かない

コメントを書く必要なソースコードは、粒度が大きい可能性があり、
ソースコードで表現できないからコメントが必要になると思います。

TODOや仕様を書きたい場合もありますが、別途タスク管理ツールを使うことをお勧めします

まとめ

プロジェクトによっては、コメントを細かく書く事もあると思いますが、必要以上のコメントは可読性も悪くなりコストもかかると思います。
そのコメントが間違っている可能性もないとは言い切れません。

コメントではなくコーディングに注力したいですね♪

追記

コメントはなるべく書かないと記載しましたが、
facadeパターン等で中身が追いにくいものに関しては書いてもいいと思いました。

0
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
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?