コメントは読むのに時間がかかるし、画面も占有する。
コメントを書く際は、読むに値する内容を記述しよう。
コードを書く際は、下記点を意識しよう。
* コードを読んでわかることはかかない
* コメントを記載する前に、リファクタリングをしてコードで伝えられるようにならないか考える
また、下記の様なルールを採用して、コメントを記述していこう。
| 記法 | 意味 |
|---|---|
| TODO: | 後でやる |
| FIXME: | 不具合のあるコード |
| HACK: | その場しのぎの解決 |
| XXX: | 大きな問題がある |
More than 5 years have passed since last update.
Register as a new user and use Qiita more conveniently
- You get articles that match your needs
- You can efficiently read back useful information
- You can use dark theme
List of users who liked
22