2020年1月6日 星期一

讀書心得 - Clean Code - Chapter 5

Chapter 5 - 編排

報紙的啟發


    希望原始檔要跟報紙一樣,從上而下閱讀。上方會有頭條的敘述,讓你理解這段報導在談論些什麼,讓你可以決定如何閱讀。第一段通常會是整篇報導的概要,細節資訊會被隱藏。然後你在持續往下閱讀才會發現所有細節。

    然後報紙本身也不會太長,所以原始檔盡量維持最多 200 ~ 500 行。
    垂直空白區隔
    每一個空白行會對眼睛下一個提示,讓其注意空白行後的第一行。通常用在一個概念接續另新的概念。
    垂直密度
    相依的函式盡量緊靠。
    垂直順序
    跟報紙一樣,應該是高層模組到低層模組。
    水平的空白間隔
    水平空白去強調運算子,下面是用空白強調加減法,以及乘法有較高的優先權所以沒有空白。
     public class Quadratic {
          public static double root1(double a, double b, double c) {
               double determinant = determinant(a, b , c);
               return (-b + Math.sqrt(determinant)) / (2*a);
          }
  
          public static double root2(double a, double b, double c) {
               double determinant = determinant(a, b , c);
               return (-b - Math.sqrt(determinant)) / (2*a);
          }
  
          private static double determinant(double a, double b, double c) {
               return b*b - 4*a*c;
          }
     }

上一篇:
讀書心得 - Clean Code - Chapter 4

Related Posts:

  • 讀書心得 - C++ Primer (5th Edition) - Chapter 1 簡單的 C++ 程式     要寫一個 C++ 程式跟 C 一樣,寫好 cpp 檔,交給編譯器 ( g++ ) 編成可執行程式。程式至少包含一個名為 main 的 function,用以當作程式的入口 function。 int main() { return 0; // return 0 的原因為 0 通常代表著程式執行成功。 } Input/Output    … Read More
  • 讀書心得 - Clean Code - Chapter 3 (2) Chapter 3 - 函式 - 2 使用具描述能力的名稱     不要害怕名字過長,若取了有性質的函式名稱就較能符合「當每個你看到的函式,執行結果都與你想的差不多代表為 Clean Code」。 函式的參數     函式的參數越少越好,因為參數的存在也會影響著你對函式的預期,所以最理想的情況為 0 參數。     一個參數 與這個參數有關的問題 - boole… Read More
  • 讀書心得 - C++ Primer (5th Edition) - Chapter 2 (1) - Primitive Types C++ 原生內建的資料型態 ( Primitive Types )     C++ 定義了一些算術用的資料型態 ( Arithmetic Types ) 和一個特殊的資料型態 void。Arithmetic Types : Integer, Character, Boolean, Floating Point, Double Floating Point, Wide Character。     下面為一… Read More
  • 讀書心得 - Clean Code - Chapter 2 Chapter 2 - 有意義的命名 使之名符其實      選一個好的名稱很花時間,但省下的時間更多。 // 沒命名 public List<int[]> getThem(){ List<int[]> list1 = new ArrayList<int[]>(); for (int[] x : theList) … Read More
  • 讀書心得 - Clean Code - Chapter 3 (1) Chapter 3 - 函式 - 1 首要準則 - 簡短!!     即使現今編輯器能讓你在一行塞入 150 個英文字母,現今螢幕能讓你顯示 100 行,你也不該塞好塞滿。越短越好,3 ~ 4 行,每個函式都透漏著本身的意圖且帶領著你至下個函式。     區塊 ( Blocks ) 和縮排 ( Indenting )     If、else、while 都應該只有 1 行… Read More

0 意見:

張貼留言

Popular Posts