代碼規範

代碼規範

1.自己的代碼讓別人看得懂
2.保持一致性 風格一致比"正確"更重要

規範要求

1.規範要求——命名

  1. 把信息裝在名字裏
  2. 具體的名字代替抽象的
  3. 名字附帶更多信息
  4. 名字不能太長
  5. 不會有歧義的名字

2.規範要求——註釋

好註釋:法律信息、提供信息的註釋、對意圖的註釋、闡釋、警示、 TODO註釋(解釋了爲什麼該函數的實現部分無所作爲,將來應該是怎樣)、放大(突出重要性)、公共API中的Javadoc。
壞註釋:楠楠自語、多餘的註釋、誤導性註釋、循規式註釋、日誌式註釋、廢話註釋

  1. 什麼時候不需要註解
  2. 公佈可能的陷阱
  3. “全局觀”註釋
  4. 言簡意賅的註釋

3.規範要求——循環和邏輯

  1. 處理順序
  2. 避免do/while語句
  3. 理解執行的流程
  4. 拆分超長表達式
  5. 變量與可讀性
    減少變量、減少變量作用域
  6. 儘量只寫一次變量

4.規範代碼——組織代碼

  1. 一次只做一件事情
  2. 把想法變成代碼
  3. 保持小代碼庫
  4. 熟悉代碼庫

5.規範要求——測試與可讀性

原則:對使用者隱去不重要的細節,以便更重要的細節會更突出

  1. 讓錯誤信息具有可讀性
  2. 大型”破壞性“測試

6.規範定義——源碼文件

  1. 編碼格式:UTF-8
  2. import,不使用通配符
  3. 類成員順序:
    A、publi-protected-private
    B、類成員在上,方法在下
  4. 格式
  5. 命名原則:使用可搜索的名稱、提防使用不同之處較小的名稱、常用對仗詞
  6. 函數:
    避免連續調用、
    分割指令與詢問、
    不要使用異常控制循環體、
    避免修改入參
  7. 避免暴露細節
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章