Help us understand the problem. What is going on with this article?

読書まとめ:リーダブルコード 第6章

More than 5 years have passed since last update.

第6章 コメントは正確で簡潔に書く

  • 複数のものを指す可能性がある「それ」や「これ」などの代名詞を避ける

  • 関数の動作はできるだけ正確に説明する

  • コードの意図は、詳細レベルはなく、高いレベルで記述する

  • よくわからない引数にはインラインコメントを使う。(例:Function(/* arg = */ ...))

  • コードを読んだ人が疑問って思うところを予想してコメントを書く

  • 多くの意味が詰め込まれた言葉や表現を使って、コメントを簡潔に保つ

所感

簡潔なコメントを書くためには、日本語の語彙力と短くまとめるスキルを身につけることが重要だと感じる。
起承転結を意識した文章作成を行う。

kiyomaru
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away