Recommended
More Related Content
Featured
Featured (20)
Readable Code Summary
- 1. リーダブルコード The Art of Readable Code
- 4. 第Ⅰ部 表面上の改善
- 10. ①情報に名前を詰め込む 1-1. 明確な単語を選ぶ 明確で正確な言い回し NG例） get →fetch、download size →height、memoryBytes stop →kill、pause 2-1. 汎用的な名前を避ける 何にでも使える名前は避ける NG例） retval →目的や値を表すものへ tmp →一時的な情報の保存の の場合は使って良い 2-2. ループイテレータ 複数あるときは説明的な名前に ループイテレータ：i、j、kなど 説明的な名前： i →user_i、member_i、など ②汎用的な名前を使わない 参考：プログラミングでよく使う英単語のまとめ【随時更新】
- 11. ③具体的な名前を使う 3-1. 具体的な名前を使う 名前と目的を一致させる 日本語でいう「〇〇が」「〇〇 を」の部分を名前で表す 例） disallow_evil_constructor →disallow_copy_and_assign 4-1. 値の単位の追加 変数名に単位を入れる 例） start →start_ms size →size_mb limit →limit_kbps delay →delay_secs angle →degrees_cw 4-2. 重要な属性の追加 意味を間違えたとき深刻な被害 が出るところに危険や注意を喚 起する情報の追加 例） データが安全でない→unsafe〇 〇、untrusted〇〇 暗号化すべき→plaintext_〇〇 ④名前に情報を追加する
- 12. ⑤名前の長さを決める 5-1. 名前の長さを決める いい名前= 「長い名前を避ける」 という暗黙の制約 →どこで折り合いをつけるべきか のガイドライン 5-2. 短い名前でもいい スコープが小さければ短い名前 でもいい →名前が適用されているコード の行数が小さければ、コード理 解に必要な情報がすぐそばにあ るため 5-3. 単語補完機能を使う エディタの単語補完機能を使う ことで正確な単語が入力できる 例） InteliJ IDEA →Alt-/
- 13. ⑤名前の長さを決める 5-4. 省略形 スラングな省略形以外は使わない 例） evaluation →evail document →doc NG例） BackEnd →BE 5-5. 不要単語の切り捨て 削除しても問題ない単語は切り 捨てる 例） DoServeLoop →ServeLoop ConvertToString →ToString 6-1. フォーマットで伝える フォーマットの違いで情報を伝 える 例） クラス名→キャメルケース 変数名→スネークケース HTML id →スネークケース class →ケバブケース ⑥フォーマットで情報を伝える
- 14. 第3章 誤解されない名前
- 18. ②限界値/範囲/排他的範囲/ブール値 2-1. 限界値 限界値を含めるとき（~以上、~ 以下） →minとmaxを使う 例） max_〇〇 min_〇〇 2-2. 範囲 範囲を示すもの →firstとlastを使う （min、maxでも良い） 例） set.PrintKeys(first="a", last="e") print int_rang(min=2, max=4) 2-3. 包含/排他的範囲 最初は含むが最後の要素は含ま ないもの →beginとendを使う 例） 何時から何時まで開催など
- 19. ②限界値/範囲/排他的範囲/ブール値 2-4. ブール値 ブール値を返す関数 →trueとfalseの意味が通るよう な名前にする 例） is、has、can、shouldなどを つけて分かりやすく 3-1. ユーザーの期待 エンジニア業界のスラングを理解して 名前に反映させる 例） get() 、〇〇.list()、〇〇size() →軽量なメソッド generate〇〇()、〇〇.countSize() →重量なメソッド ③ユーザーの期待に合わせる ④複数の名前の検討 4-1. 複数の名前の検討 類義語を調べて比較する →適切な名前を選ぶ
- 20. 第4章 美しさ
- 23. ①一貫性のあるレイアウト 1-1. 一貫性のある改行位置 改行位置はコード全体を通して 同じ位置にする →全体のシルエット的に見やす いコードにする 1-2. 一貫性のある並び 一連のコードでは同じ並び順に する 1-3. シルエットの統一 複数のコードブロックで同じよ うなことをしていたら、シルエ ットも同じようなものにする
- 25. ③ブロック分け 3-1. 宣言をブロックにまとめる 単位を作ってブロックにまとめる 例） // ユーザーの友達取得 friends = user.friends() // メールアドレスのインポート contacts = import_contacts(user.emai) 3-2. 段落に分割する コードを段落分けする →空行を使って、ブロックを論 理的な段落に分ける
- 30. ①自分の考えや気付き 1-1. 採用理由 1-2. 開発中の気付き 開発中に気付いた欠陥などを， 「Todo：」，「Fix：」を使っ てメモしておく（チームで事前 に統一しておく） 他にも実装方法やライブラリが ある中，なぜ他の方法ではな く，この手法を採用しているの か 1-3. 定数の設定理由 定数や値の設定理由 ex)なぜこのリストは1000まで 入るようにしているのか，など
- 31. ②読み手の理解を促進するためのメモ 2-1. 詰まりそうな箇所 2-2. プログラムの概要 ファイルやクラスには全体像を コメント ex)これは〇〇をするためのクラ スです，使い方は△です 読み手が「えっ？」っとなりそ うなところをあらかじめ予想し て，コメントで書いておく 2-3. ロジックの説明 ロジックは改行を入れるなどし てブロックに分け，各ブロック にはコメントを付けて概要を補 足 //ユーザーID取得 //IDを用いてDBからデータ取得
- 32. 第６章 コメントは正確で簡潔に
- 36. 第Ⅱ部 ループとロジックの単純化
- 37. 第7章 制御フローを読みやすく
- 40. ①条件式の引数の並び順 1-1. 条件式の引数 左：調査対象（~はの部分） 右：比較対象 例） if(length >=10) →◯ if(10 <= length) →× 2-1. if/elseのルール ①肯定形> 非定形 - !はなるべく使わない ②単純な条件を先へ -ifとelseが同じ画面に表示される ③目立つ条件を先へ ②if/elseのルール
- 41. ③三項演算子、do/whileループ、goto 3-1. 三項演算子 三項演算子は基本使わない （条件? a : b） →1行で書いた方が読みやすい 場合のみ使う 3-2. do/whileループ do/whileループは基本使わない →whileループで書く 3-3. goto gotoは基本使わない →普通のループに置き換える
- 42. ④ネストを浅くする 4-1. ネストを浅くする ネストの深いコードは読みにくい →1つのネスト内に書くコードは なるべく簡潔になるようにする。 4-2. ループ内部のネストの削除 ループ内部でネストしているコー ドは読みにくい →書き方変える/ループを分ける。 ⑤早めに返す 5-1. 早めに返す 関数で早めに返してあげると、 ネストを削除したりコードをク リーンにしたりできる。
- 44. 第8章 巨大な式を分割する
- 47. ①説明変数 1-1. 説明変数 式の意味を説明する変数 例） if line.split[0].strip() == "root": ↓ username = line.split[0].strip() if username == "root": 1-2. 要約変数 式を代入しておく変数 →大きなコードの塊は変数に代 入すると読みやすくなる 例） if(request.user.id == document.owner_id) ↓ user_owns_document = ... ②要約変数
- 48. ③ド・モルガン法則 3-1. ド・モルガン法則 not(a or b or c) ⇅ (not a) and (not b) and (not c) not(a and b and c) ⇅ (not a) or (not b) or (not c) notを分配してand/orを反転させる 4-1. 短略評価 短略評価： 論理演算子（&&, ||）は左辺を評 価した時点で式全体の真偽値が 決定し右辺を評価する必要がな いもの →長すぎる式の場合は、変数を 使って分割する ④短絡評価
- 49. 第９章 変数と読みやすさ
- 52. ①変数を削除する 1-1. 役に立たない一時変数 now = datetime.datetime.now() root_message.last_view_time = now ←nowっていう一時変数いらない 直接代入しちゃえばいい 1-2. 制御フロー変数の削除 boolean done= false; while(条件&& !done){ → ... if(...) { done=true; continue; } } 制御フロー変数doneの削除 while(条件){ ... if(...) { break; } }
- 55. 第Ⅲ部 コードの再構成
- 59. 第11章 一度に1つのことを
- 62. 第12章 コードに思いを込める
- 66. 「権限あり/なし」，「時間/銘柄/価 格」など，ロジックを構成する上で重要 となりそうなキーワードに着目する 2-2. 簡潔にコードを書く ロジックの説明を実装する再，難 しい/不自然なコードではなく， 他者が読みやすいよう，できるだ け簡潔で自然なコードを書く ②説明に合わせてコードを書く 2-1. キーワードやフレーズ に注目する 2-3. ライブラリを知る 簡潔なコードを書くために，ライ ブラリが何を提供してくれてるか を知ることが欠かせない．ライブ ラリの内容を知る時間を作り，実 際に利用する
- 67. 第13章 短いコードを書く
- 72. 3-1. ユーティリティ化 重複コードを汎用的な「ユーテ ィリティコード」にする ≒オブジェクト指向 3-2. コードの削除 「コードをせっかく書いたから， 削除したくない」そんなのどうで もいいんだよ！ 未使用のコードは無用の機能はど んどん削除しよう ③コードを小さく保つ 3-3. 外部リソースの利用 - 言語の標準ライブラリ - 外部API - Unixコード を用い，コード量を減らす "たまには標準ライブラリのすべ ての関数を15分かけて読んでみ ろ！"