2018-08-08 - Lisa’s Code Standard

目錄：
1、字串
2、註釋規約

---

一、字串

1.1、字串一定要放在strings.xml裡面，不要直接用

1.2、字串佔位符的使用：佔位符使用詳解

三種佔位符格式：

• %n$ms ： 輸出的是字串，n代表是第幾個引數，設定m的值可以在輸出之前放置空格
• %n$md： 輸出的是整數，n代表是第幾個引數，設定m的值可以在輸出之前放置空格，也可以設為0m,在輸出之前放置m個0
• %n$mf：輸出的是浮點數，n代表是第幾個引數，設定m的值可以控制小數位數，如m=2.2時，輸出格式為00.00

<string name="voice_hearer_init_error">
        語音監聽 初始化失敗,錯誤碼：<xliff:g id="error_code">%1$d</xliff:g>
        
String toastContent = activity.getResources().getString(R.string.voice_hearer_init_error,code);

二、註釋規約

2.1、類註釋

所有的類都必須新增建立者和建立日期

2.2、使用Javadoc註釋類、類屬性、類方法

類、類屬性、類方法的註釋必須使用 Javadoc 規範，使用【/**內容**/】格式，不能使用【//內容】

2.3、抽象方法必須用Javadoc註釋

所有的抽象方法(包括介面中的方法)必須要用 Javadoc 註釋，除了返回值、引數、 異常說明外，【對子類的實現要求，或者呼叫注意事項，也要一併說明】

2.4、單行註釋用// ，多行註釋用/* */

方法內部註釋，單行註釋用【//】，多行註釋用【/*內容 */】，注意對齊

2.5、列舉每個資料項要註釋

所有的列舉型別都要註釋，說明每個資料項的用途

2.6、註釋注意中英文

不要用半吊子英文註釋，關鍵詞和專有名詞可保持英文

2.7、❗️程式碼修改與對應註釋要同步

程式碼修改後，要同步修改註釋。尤其是引數、返回值、異常、核心邏輯等等

2.8、謹慎註釋掉程式碼。

註釋掉的程式碼要註釋說明。沒用就果斷刪掉。

2.9、註釋的要求

• 9.1、能夠準確反應設計思想和程式碼邏輯;
• 9.2、能夠描述業務含義

2.10、讓程式碼自解釋，註釋太多是負擔

儘量做到讓程式碼自解釋，註釋太多也是一種負擔。註釋要求精簡準確、表達到位。

2.11、❗️特殊註釋標記【TODO、FIXMI】要註明標記人和標記時間和預計處理時間

• 1、【TODO】待辦事宜：( 標記人，標記時間，[預計處理時間])
• 2、【FIXME】錯誤，不能工作：(標記人，標記時間，[預計處理時間])