『リーダブルコード』を学習する2

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

序文

リーダブルコード学習2日目。(本当は3日目)
GWも特に予定もないので(毎月末恒例で映画を見に行ってるぐらい)、どこかの勉強会に参加しようと思って申し込んだのですが、キャンセル待ちになってしまったので、さらに予定が立てられなくなりました。
どこかで見かけたらやさしくしてください。

GitHub

github.com

進捗

  • 4章 美しさ
  • 5章 コメントすべきことを知る(途中)
    (学習時間:3時間)

コード実装部分(一部)

  • 価値のないコメントをしない

\CodeExample\5章 コメントすべきことを知る\5-1 コメントするべきでは「ない」こと\find-node-in-subtree.js

// 価値のないコメント(せやろか)

// 与えられたsubtreeに含まれるnameとdepthに合致したNodeを見つける
function findNodeInSubtree(subtree, name,depth){
  // 処理
}

/*******************
 改善例
********************/
// 関数名から読み取れないことをコメントする

// 与えられたnameに合致したNodeかNULLを返す
// もし depth <= 0 ならば、'subtree' だけを調べる。
// もし depth == N ならば、'subtree' とその下のN階層まで調べる
function findNodeInSubtree(subtree, name,depth){
  // 処理
}
  • その他実装部分

github.com

実行結果

ねえよ

感想

今日はコードの整形とコメントについて。

getPrice();

みたいな関数に

//値段を取得する  

みたいなコメントは無駄だから書くな!って趣旨なんだけど、日本語と英語じゃ全然事情が違うよね。

こういう本は日本語のライターさんがリライトすることにも一定の価値があるんじゃないかなぁ。
技術評論社様、翔泳社様、SB Creative様、秀和システム様(順不同)、 ご検討をよろしくお願いします。

カロリーメイトください。

BGM

プレイボール / YUKI www.youtube.com YUKIちゃんのフォロワーになりたいんだろうなって音楽やってる子いっぱいいるけど、正直足元にも及んでないって思っちゃうわ。