#20 コメント① コメントを「ちゃんと書く」って何?
Listen now
Description
■ トピック 「コメントをちゃんと書きましょう」 コードの日本語訳のようなコメントは消してほしい 良くないコメントがあるよりは無い方がマシ コメントを書かないでいいようなコードを書きたい 「何を書いてはいけないのか」がわからないといけない コードスメル、消臭剤としてのコメント 情報として有益であっても消されるべきコメント 申し訳なさとともにコメントを書く 交通標識のように機能するコメント 読まれるべきコメントへの注意を引くためにはS/N比が大事 ■ 参考リンク O'Reilly Japan - リーダブルコード エンジニアのためのドキュメントライティング - JMAM 日本能率協会マネジメントセンター リファクタリング(第2版) 既存のコードを安全に改善する | Ohmsha ■ おたよりフォーム https://forms.gle/RYUG7T4ctmF7Srf36 ■ X(Twitter) https://twitter.com/refactoradio ハッシュタグは #リファラジ です。
More Episodes
■ トピック 祝・第50回 最新情報を追跡するルーチン インプットのプッシュ型とプル型 メールの未読ゼロ GitHubからの通知 Discordでキャッチアップする ちゃんと読みたいものは時間を見つけてプル型で SNSでの情報収集 英語原文でのインプット Zennにトレンドを探しにいく エラーの解決方法の探し方 具体と抽象を行き来しないと解決できない AIの使い方 ■ 参考リンク JSer.info Blog | web.dev ■...
Published 11/25/24
※ お詫び: 収録時のミスでlacolacoの音質が悪いです。 ■ トピック リファクタリングモードに入ってまずやること 名前を変えてみる 既存コードをいったん消して書き直してみる コメントを書き足すだけでもリファクタリング 「3つ目」が降ってくるとき 趣味と業務 知識が不確実だと備えが必要 いつでもリファクタリングはじめられるためにやっていること ディレクトリ構造をきれいにしておく 新しいメンバーからのフィードバックは大事 雑にリファクタリングしまくるためのテストとCI 「テストが書ける状態」でテストが書かれることなくない? ...
Published 11/18/24