リーダブルコード 5-6章 コメントについて · GitHub

readable-code-chap5-6.md 5章 コメントすべきことを知る コメントの目的は書き手の意図を読み手に知らせることである コメントすべきでないことを知る コードを書いているときの自分の考えを記録する 読み手の立場になって何が必要かを考える コメントすべきではないこと パっとみて当たり前にわかることをコメントに書かない // 休日を計算する function caliculateHoliday() { ... } // 関数実行時の年の1/1から12/31まで、祝日を除く休日を計算する function caliculateHoliday() {....} コメントにパッと見でわからないことを書くようにしよう 関数名がひどい場合はコメントではなく関数名を書く // Kintoneのカスタマイズでコメントを128kbに制限する // コメントにはコメント内容、コメント時刻、コ

[tanakakazu]

こういう書籍や雑誌の特集をそのまま、まとめたみたいのをちょくちょく見るけど、いいのかって気になるわ。

[tossy_yukky]

昨日のロシア人思い出した

[gachapining]

本の内容を転記することの問題提起ブクマかと思った。リーダブルコードくらい買って読んで欲しい‥

[junpeso]

これ書かれた当初はdocumentorやswaggerとかのエコシステムが充分でなかった時代なのでソースコード側でもりもり説明する方針なんだと思う。ちゃんと自分の環境に合わせて取捨選択するのが大事。

[maruhoi1]

リビジョン管理されてるから全文残ってるのGitHubって感じだ / 404になった

[eru01]

githubで削除する意味

[Error401]

コードはコピペじゃなくて自分でかいてたんですけどね・・・

[yood]

引用の範囲を超えていると思うが、アフィでも無いし、リーダブルコードの価値を下げるものでもない。他の分野なら兎も角、技術的なメモに目くじら立てたくないな。

[eerga]

原文みてないけどまとめただけなら著作権法違反です

[mangakoji]

直したところを書く(ここはハマりやすい場所なのでnote)

[dlive1]

コメントの目的は書き手の意図を読み手に知らせること。パっとみて当たり前にわかる事はコメントに書かない

[toririr]

なんでサムネがエネゴリくん?

[jssei]

ゴミコメントばかり書いてた。参考にする。

[yogasa]

//あとでなおす

[NOV1975]

正しい。場合によっては設計書にちゃんと書いてあるなら不要。実装の工夫はコードにコメントしよう。

[Helfard]

// なるほどね、完全に理解したわ←

[otihateten3510]

アンチコメント派はこういうのも書かないよね。コード読んだらエスパーのように分かるんだろうね。／本の方をちゃんと読んだ方がいい

[kastro-iyan]

名著。発行から数年経っても価値が損なわれていない。

[kura-2]

//名前は適当、あとで直す functionA()的なやつが商用のコードに入っててめまいしたことある

[kencharos]

名著と言われる所以だ