リファクタリングとともに生きるラジオ

#20 コメント① コメントを「ちゃんと書く」って何?

文字起こしあり

2024.4.30

17:56

■ トピック 「コメントをちゃんと書きましょう」 コードの日本語訳のようなコメントは消してほしい 良くないコメントがあるよりは無い方がマシ コメントを書かないでいいようなコードを書きたい 「何を書いてはいけないのか」がわからないといけない コードスメル、消臭剤としてのコメント 情報として有益であっても消されるべきコメント 申し訳なさとともにコメントを書く 交通標識のように機能するコメント 読まれるべきコメントへの注意を引くためにはS/N比が大事 ■ 参考リンク O'Reilly Japan - リーダブルコード エンジニアのためのドキュメントライティング - JMAM 日本能率協会マネジメントセンター リファクタリング(第2版) 既存のコードを安全に改善する | Ohmsha ■ おたよりフォーム https://forms.gle/RYUG7T4ctmF7Srf36 ■ X(Twitter) https://twitter.com/refactoradio ハッシュタグは #リファラジ です。

Loading...