rabbit-slide-kou-schoo-readable-code-2015-04 2015.4.3.1 → 2015.4.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23cc1c9aec53ccaba058272cdd69c2fecc4b952b
-  data.tar.gz: 64951a479946b23e222366824c9eaeb68a821b37
+  metadata.gz: d6d3ad0c9ee6f98d0020259259c4648843cc5c2b
+  data.tar.gz: 2741d1c843db3c8570c7b299150e8d12483b497c
 SHA512:
-  metadata.gz: 281337d0b6c01dcafc7b5a8a4f174e0f2affb14f9dc7881bc8dba2b3aadeccfe8bc174e1e332e32a8628003ae6110913d9936bcd75f44de54b0649080e207807
-  data.tar.gz: 69822379c200cbc7275e67aab0083d08d405a3868c2abfd4977c1051d7041f0bf044b2ed6daf19f47fcdf26d6c9411ae5c827b397ff50f3142dbab3942ef0216
+  metadata.gz: 31cb8f4afd0157ac5bc93950865d36321da556b1c22b7b2e202de84a6fde0f1ce1b44fe16f32f19156a9c0de45bb7b00b4e00ef6a1874ac94dea31d8ec482cbc
+  data.tar.gz: a391a026bbcc32bcc4a4519fa2be58f82366f9e8a7235b1901e529ecd684ef8f52203a9bdc3258bca1f43de532327a403e4ff94896f5082278d8ee9c7b31f2cd

data/chapter-7.rab

@@ -142,17 +142,15 @@
 
   // どちらがリーダブルコード？どうして？
   // リーダブルコード：変更できる・バグを見つけられるコード
-  // A.
-  Node* node = list->head;
-  if (node == NULL) return;
-  while (node->next != NULL) {
-      Print(node->data);
-      node = node->next;
-  }
-  if (node != NULL) Print(node->data);
-  // B.
-  for (Node* node = list->head; node != NULL; node = node->next)
-      Print(node->data);
+  // A                           // B
+  Node* node = list->head;     | for (Node* node = list->head;
+  if (node == NULL) return;    |      node != NULL;
+  while (node->next != NULL) { |      node = node->next)
+      Print(node->data);       |     Print(node->data);
+      node = node->next;       |
+  }                            |
+  if (node != NULL)            |
+      Print(node->data);       |
 
 (('tag:center'))(('note:「優れた」コードって何？ p. 2より'))
 
@@ -251,33 +249,59 @@
     * 左側：変化する式
     * 右側：変化しにくい式
 
-= 7.2 例：処理の順番
+= 7.2 例：処理の順番（1）
 
   # coderay c
 
-  /* A            | B            */
+  /*     どちらがリーダブル？    */
+  /* A */         | /* B */
   if (a == b) {   | if (a != b) {
     /* ケース1 */ |   /* ケース2 */
   } else {        | } else {
     /* ケース2 */ |   /* ケース1 */
   }               | }
 
-(('tag:center'))
-どちらがリーダブル？
-
-= 7.2 例：処理の順番
+= 7.2 例：処理の順番（1）
 
   # coderay c
 
-  /* A            | B            */
+  /*    A：条件が肯定形だから    */
+  /* A */         | /* B */
   if (a == b) {   | if (a != b) {
     /* ケース1 */ |   /* ケース2 */
   } else {        | } else {
     /* ケース2 */ |   /* ケース1 */
   }               | }
 
-(('tag:center'))
-A（左）の方がリーダブル
+= 7.2 例：処理の順番（2）
+
+  # coderay c
+
+  /*     どちらがリーダブル？    */
+  /* （ケース1の方が処理が長い） */
+  /* A */         | /* B */
+  if (a == b) {   | if (a != b) {
+    /* ケース1 */ |   /* ケース2 */
+    /*   ...   */ |  } else {
+    /*   ...   */ |   /* ケース1 */
+  } else {        |   /*   ...   */
+    /* ケース2 */ |   /*   ...   */
+  }               | }
+
+= 7.2 例：処理の順番（2）
+
+  # coderay c
+
+  /*   B：単純な処理の条件が先   */
+  /*    if/elseを一望しやすい    */
+  /* A */         | /* B */
+  if (a == b) {   | if (a != b) {
+    /* ケース1 */ |   /* ケース2 */
+    /*   ...   */ |  } else {
+    /*   ...   */ |   /* ケース1 */
+  } else {        |   /*   ...   */
+    /* ケース2 */ |   /*   ...   */
+  }               | }
 
 = 7.2 指針
 
@@ -341,11 +365,32 @@ A（左）の方がリーダブル
   # coderay java
 
   public boolean Contains(String str, String substr) {
-    if (str == null || substr == null) return false;
-    if (substr.equals("")) return true;
+    if (str == null || substr == null) // ガード節
+      return false;
+    if (substr.equals(""))             // ガード節
+      return true;
+    // 大事な処理だけに興味があるなら↑までは無視可能。
+    // 大事な処理は↓から。
     // ...
   }
 
+= 7.5 ガード節なし
+
+  # coderay java
+
+  public boolean Contains(String str, String substr) {
+    if (str == null || substr == null) {
+      return false; // 異常値
+    } else {
+      if (substr.equals("")) {
+        return true; // 特別値
+      } else {
+        // 大事な処理はここ。ネストが深い。
+        // ...
+      }
+    }
+  }
+
 = 7.5 ガード節の効果
 
   * 以降の処理が単純になる
@@ -373,7 +418,7 @@ ifとreturnの使い方\n
 
   # coderay ruby
 
-  if 条件    | return if 条件
+  if 条件    | return if !条件
     サブ処理 |
   end        | サブ処理
 
@@ -404,16 +449,15 @@ ifとreturnの使い方\n
 
   # コメントを追加するメソッドだな！
   def add_comment(post, user, text)
-    if post.hidden_from?(user)
-      # コメント追加しないの！？
+    if post.hidden_from?(user) # ユーザーに見えない投稿なら…
       report_access_error
+      # エラー処理か。ifの後にもなにか処理はあるのかな？
     else
-      # else（その他）の方の処理だけど
-      # このメソッドにとって大事な処理か
-      # ifの方と同列の大事さの処理かと思った
       comment = Comment.create(text)
       post.add(comment)
-    end
+      # ユーザーに見えるときだけコメント追加か。
+      # こうやってコメントを追加するんだな。
+    end # ifの後にはなにも処理はないんだな。
   end
 
 = 番外：例（1）return付き
@@ -422,22 +466,23 @@ ifとreturnの使い方\n
 
   # コメントを追加するメソッドだな！
   def add_comment(post, user, text)
-    if post.hidden_from?(user)
-      # すぐにreturnしているし特別な処理なんだな
-      report_access_error
-      return
+    if post.hidden_from?(user) # ユーザーに見えない投稿なら…
+      report_access_error # エラー処理をして、
+      return # それで終了か。
     end
 
-    # 通常はコメントを追加するんだな！
+    # エラー処理が終わったからここからは通常の処理だな。
     comment = Comment.create(text)
-    post.add(comment)
+    post.add(comment) # こうやってコメントを追加するんだな！
   end
 
 = 番外：例（1）まとめ
 
-  * 正常系と異常系の扱いを変える
-    * 正常系の方が重要なコード
+  * 異常系と正常系の扱いを変える
+  * 異常系はすぐにreturn
+    * エラー処理だけというのをアピール
   * 正常系はネストしない
+    * 正常系の方が重要なコード
     * 重要なコードは見やすい場所に
 
 = 番外：例（2）
@@ -458,14 +503,12 @@ ifとreturnの使い方\n
 
   # データベースを準備するんだな
   def prepare_database(path)
-    if not File.exist?(path)
-      # なかったら作るのか
-      # あれ、作るのも普通の「準備」なような…
+    if not File.exist?(path) # なかったら…
+      # 作ってすぐに終了か。あれ、作るのも普通の「準備」なような…
       return Database.create(path)
     end
 
-    # あったら開くのか
-    # やっぱりどっちも「準備」だよなぁ
+    # あったら開くのか。これも「準備」だよなぁ。
     # なにか特別な意図があるんだろうか…
     Database.open(path)
   end
@@ -476,12 +519,10 @@ ifとreturnの使い方\n
 
   # データベースを準備するんだな
   def prepare_database(path)
-    if File.exist?(path)
-      # あったら開いて
-      Database.open(path)
-    else
-      # なかったら作るのか
-      Database.create(path)
+    if File.exist?(path) # あったら…
+      Database.open(path) # 開いて
+    else                   # なかったら…
+      Database.create(path) # 作るのか
     end
   end
 
@@ -507,16 +548,16 @@ ifとreturnの使い方\n
   // 読みやすい制御フローにして投稿・よい投稿に「いいね！」して応援
 
   function positiveIntegerSum(n) { // n以下の正の整数の合計を返す
-    if (0 >= n) {
-      return -1; // エラー
-    } else {
-      var total = 0;
-      for (; n > 0; n--) {
-        total += n;
-      }
-      return total;
-    }
-  }
+    if (0 >= n) {            // ヒント:
+      return -1; // エラー   // 1. 条件式の並び順
+    } else {                 //    * 左に変化するもの
+      var total = 0;         //    * 右に変化しにくいもの
+      for (; n > 0; n--) {   // 2. 処理する条件の順番
+        total += n;          //    * 肯定形で書く
+      }                      //    * 単純な条件を先に書く
+      return total;          //    * 関心がある条件を先に書く
+    }                        //    * 目立つ条件を先に書く
+  }                          // 3. ガード節
 
 = まとめ（1）
 
@@ -531,7 +572,7 @@ ifとreturnの使い方\n
     考えた
     * 条件式内の並び順
       * →左に変化するもの・右に変化しにくいもの
-    * 条件による処理の順番
+    * 処理する条件の順番
       * →肯定形で書く・単純な条件を先に書くなど
     * ガード節
       * →特別なケースはすぐにreturn
@@ -561,8 +602,9 @@ ifとreturnの使い方\n
     * コードから学ぶ気持ちで読む
     * ×悪いこと探し
     * ○いいこと探し
-    * 本来、コードを読むことは\n
-      楽しいことのはず！
+  * 読むコード
+    * オススメは自分が使っているOSS
+    * ↑動作を知っているから読みやすい
 
 = 悪いコード
 

data/config.yaml

@@ -6,7 +6,7 @@ tags:
 - readable-code
 - schoo
 presentation_date: 2015-04-03
-version: 2015.4.3.1
+version: 2015.4.3.2
 licenses:
 - CC BY-SA 4.0
 slideshare_id: 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rabbit-slide-kou-schoo-readable-code-2015-04
 version: !ruby/object:Gem::Version
-  version: 2015.4.3.1
+  version: 2015.4.3.2
 platform: ruby
 authors:
 - Kouhei Sutou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rabbit