編碼規范

Ⅰ、項目文件夾

1、安卓按照MVP模式,iOS按照MVC模式對工程文件進行歸類管理;

2、項目文件夾、類名、變量名等不能使用中文進行命名;

3、按照權責分門別類存放資源文件:每種類型的資源存放于獨立的目錄下:圖片,聲音,配置文件等等;

4、同一功能需求,不要導入多個第三方庫;

Ⅱ 、類、方法、變量

1、類名開頭大寫,方法和變量名以駝峰法命名;

2、類的頭部注釋需要備注該類的功能;

3、定義自己的 UI 基類;

4、常量的聲明注釋放在常量名上方,在本類中聲明的變量較少時,變量聲明注釋放在變量名上方,如果有較多的變量,則可將注釋放在右側;

5、聲明相關性較強的變量時,放在一起,相關性不同的兩組變量之間間空出一行;

6、將判斷狀態的常亮定義為枚舉類型,增強代碼的可讀性;

7、方法前要添加模板注釋(功能、參數作用、作者、時間、版權信息)

8、方法參數較多時,注意換行,增強代碼的可讀性;

9、方法中邏輯性代碼需要進行注釋;

Ⅲ、網絡請求

1、接收返回數據的控制器不存在時,收到后臺返回數據回調直接return;

2、頁面刷新、按鈕點擊等操作,需要向后臺發送數據時,注意避免重復發送請求;

圖解(轉載自臭碼農)

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容