Brian的雜記
  • Introduction
  • Brian's 雜記
    • My Awesome API
    • FB 大頭貼
    • 硬體雜記
    • PHP
    • project
      • 模擬器
      • WAMP
    • WinMerge
    • 雜記
      • LINQ
      • 方法
      • Grid View
      • namespace
      • global
      • 物件導向
      • Excel
      • VS2017
      • single sign on
      • Master
      • Https
      • 憑證
      • 略過憑證不符
      • NLog
      • 團隊開發
      • .NET Core
      • 共用網路上的芳鄰
      • 爬蟲
      • NPOI
      • RSS
      • 多執行緒
      • 記憶體回收
      • 密碼學
        • BCrypt
        • AES
      • 主機環境建置
      • Session
      • Error
      • IIS 相關
      • 無障礙相關
      • 介面
        • 影像地圖
      • telnet
        • smtp
      • nslookup
      • 協助客戶解決問題
      • 驗證欄位
      • 網站管理
      • 工具整理
    • 正規表示法
    • 影像處理
    • IntelliJ Idea
    • 觀念
      • Clean Code
        • 命名
        • 函式
        • 註解
        • 編排
        • 物件及資料結構
        • 錯誤處理
        • 邊界
        • 單元測試
        • 類別
      • Java 程式風格
      • Design Pattern
        • 單例模式
      • 同步
      • 畫圖
        • ER-Model
        • 類別圖
        • Use Case
        • 有限狀態機
      • 資料 API 文件 分析
      • CORS & SSL
      • 利用DISC幫助溝通
      • OAS
    • 檔案上傳
      • FileStore
      • App Engine
      • Google Storage
    • OAuth vs Open ID
    • MIME
    • 虛擬桌面
    • 待看資料
    • Selenium
    • CDN
    • HTTP
    • 編碼
    • 2nd-ML100Days
      • jupyter
    • 微服務
      • 設計
        • 1 ~ 5
        • 6
        • 7
        • 8
        • 9
    • Gradle
    • Maven
    • Error
    • 批次檔 BAT
    • Kurento
    • WebSocket & WebRTC
  • 需求面能力
    • User Story
  • Google Cloud Platform
    • Compute Engine
  • Python
    • 基本語法
    • Pandas
    • 套件
    • Matplotlib
    • Encoder
    • jupyter
  • Java
    • Java
      • File
      • Exception
      • 物件導向觀念
      • 加密
      • HTTP
      • 集合
      • Stream()
      • Web
      • ResultSet
      • JDK6
      • JDK8
    • 讀取、複寫MP3 Tag
    • Log4j2
    • Servlet
      • 容器
    • JSP
    • JBOSS
    • JWT
    • PreparedStatement
    • Error
    • Spring
      • Spring Boot
        • @Value
        • Build
      • RequestParameter
      • Error
      • Autowired
      • JPA
      • FeignClient
      • WebSocket
      • thymeleaf
      • Security
      • Test
      • Scheduled
      • Redirect
    • IntelliJ
  • Linux
    • Linux
    • Shell Script
    • Cygwin(在Windows執行Linux指令)
  • 前端
    • HTML
      • Link
    • CSS
      • Position
      • padding color
      • display
    • JS
      • jQuery
        • Select2
      • fancybox
      • ES6
      • 效能
      • GoogleMap API
        • Marker
        • InfoWindow
      • 事件
      • CKEditor
      • TGOS
      • JSON
      • QRcode
      • 核心概念
        • 物件 變數 型別
          • number
          • String
          • boolean
          • null & undefined
          • Symbol
        • JS 物件概念
        • 深入理解JS 函式物件
        • 更多ES2015/ES6 全新語言特性
      • Promise
    • 效果應用
  • 資料庫
    • 注意事項
    • MariaDB
    • MySQL
      • inner join 和 join
      • 字串比對
      • 倒數資料
    • SQL
      • DDL 資料定義語言
      • DML 資料操縱語言
      • DCL 資料控制語言
      • TCL 交易控制語言
      • T-SQL
      • CTE
      • JOIN
    • Oracle
    • MSSQL 操作
      • 新增使用者
      • SQL 指令
      • Sequence
    • 差異比較
    • MyBatis
    • Workbench 操作
    • SQL Injection
  • 版本控制
    • Gitlab
      • sign up
      • sign in
      • add project
      • add members
    • SourceGit
      • install
    • SmartGit
      • install
      • operate
      • git 操作雜記
    • TortoiseGit
    • Git
    • TFS
    • SVN
  • Test
    • 軟體測試原則
    • 演算法
    • XMind
      • install
    • Jenkins
      • 建置
    • HTTPie
    • Postman
    • 測試驅動開發
    • 撰寫測試的觀念
    • 測試框架
    • IoC & DI
    • 隔絕相依性的方式
    • JUnit
    • NUnit
    • 習慣
    • 虛設常式
  • Angular
    • hello world
    • ng-options
    • ES6
    • Build & Conponect
    • HttpClient
    • 部署
  • ASP.NET Web Form
    • Chapter 2
      • 2-1
        • 小東西
    • 略過請求驗證
  • Go
Powered by GitBook
On this page
  • 概念間的垂直空白區隔
  • 垂直密度
  • 垂直距離
  • 水平的編排
  • (水平的對齊)
  • 縮排
  • 重視團隊的共同準則
  • Uncle Bob的編排準則

Was this helpful?

  1. Brian's 雜記
  2. 觀念
  3. Clean Code

編排

程式的編排、可讀性、風格會在程式中立下先例,持續且深遠的影響程式的可維護性和可擴充性。

原始檔的最上方,提供高階的概念和演算法,在往下閱讀時,程式的細節才慢慢呈現出來,直到出現最低階的函式及細節為止。

概念間的垂直空白區隔

幾乎所有程式碼都是由上而下,由左至右。 每一行程式碼都代表一個表達式或某個程式子句,還有每一段程式碼都代表一個完整的思緒。

應該用空白行來分隔這些思緒

每一個空白行代表一個視覺上的提示,提示著空白行的後方將接續一個新而不同的概念。所以人的目光會被吸引到空白後的第一行。

垂直密度

垂直密度意味著密切相關的程度。

如果一群程式碼之間如果密切相關的話,它們就該是垂直緊密的。

垂直距離

在程式的垂直編排上,具有極度類似概念的應該盡可能地靠近。(很明顯,這項準則在同概念,但分散於不同檔案的情況下並不適用。但除非你有個好理由,否則相近的概念不應該分散在不同的檔案,這也是避免使用protected的理由之一)

變數宣告應該盡可能靠近被使用的地方

實體變數應該被宣告在類別的上方

(C++中通常放在類別的最下方,Java通常放在類別的最上方)

依照慣例放置,讀者就比較知道該去哪裡找 ~

相依的函式應該盡可能靠近,高階的在上方,低階的在下方(垂直的順序),這樣可以更容易尋找,藉此增加可讀性。

概念相似性的也應該盡可能靠近,例如:

assertTrue(a,b){...}

assertTrue(a){...}

assertFalse(a,b){...}

assertFalse(a){...}

水平的編排

空白有兩種用意,一種是為了突出,一種是強調運算子的優先性。

在設定運算子附近都加空白,用來突出 左邊 跟 右邊。

方法名稱和旁邊的() 要貼著,()內的參數也要貼著,因為函式和參數高度相關。

,後留空白是用來突出各個不同的參數。

method(a, b, c);

因為乘法的優先權高於加減法,所以乘法運算子的旁邊沒有空白。

(-b + Math.sqrt(determinant)) / (2*a)

(水平的對齊)

不需要做,這會造成讀者聚焦在錯誤的地方,而忽略某些東西。

縮排

一個原始檔是個階層架構

檔案 > 類別 > 方法 > 程式區塊

母程式區塊 > 子程式區塊

每一個階層都是一個視野(scope)

在某些情況下,while、for的程式區塊會是空白的,這時還是換行、縮排、留分號

while( ... )
    ;

重視團隊的共同準則

一致的風格,可以增加可讀性。

倘若一個軟體系統混合了各種不同個人風格的程式碼,會增加閱讀程式碼的複雜性。

Uncle Bob的編排準則

上大括號不會換行

單行if for 會省略大括號

Previous註解Next物件及資料結構

Last updated 5 years ago

Was this helpful?