エントリーの編集
エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
ソースコードのコメントの役割、何を書くべきかについて考えてみた - Qiita
記事へのコメント0件
- 注目コメント
- 新着コメント
このエントリーにコメントしてみましょう。
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
- バナー広告なし
- ミュート機能あり
- ダークモード搭載
関連記事
ソースコードのコメントの役割、何を書くべきかについて考えてみた - Qiita
はじめに 最近、ソースコード中に書くコメントについて他のエンジニアと話すことがあって、僕がコメント... はじめに 最近、ソースコード中に書くコメントについて他のエンジニアと話すことがあって、僕がコメントを書くときに考えてること、その役割を考えてみました。 この記事は考えたことを書き起こしたものです。 そもそもコメントは何のために書くのか コメントについて僕が大学生のころに コメントはなるべく書いたほうが良い そもそもコメントがなくてもわかるコードにするべきだ などを聞いたことがありました。(そんな気がする) 上記の例や他の意見などでも、結局何を目的としてコメントを書くのかを考えると、 「次にそのソースコードを触るエンジニアに対して、伝えなければいけないことを伝えたい」 がためにコメントを書きます。 言ってしまえば、伝言ゲームみたいな感じです。 自分が伝えたいことが次のエンジニアに伝わらないのであれば、そのコメントは意味をなしませんし、誤って伝わってしまうのであれば、そのコメントを改善する必要