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 1 year has passed since last update.

いいコード悪いコードまとめ11章コメント

Posted at

退化コメントになっていないか

開発が進むにつれて元あったコメントは更新されずに退化していくことが多い。コメントは劣化コピーに過ぎないことを理解しよう。

ロジック更新時にコメントも更新したか

可読性の悪いロジックを捕捉説明するようなコメントを書いていないか

上述の通り、コメントは退化しやすい。メソッド名を改善しよう。

ロジックの意図や仕様変更時の注意点をコメントしたか

ドキュメントコメントを使用しているか

YARD,RDocなどrubyでもドキュメントコメントを使用できる。
https://qiita.com/kmats@github/items/0c8919a65afbe18e9e37

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?