Android編碼規範

2021-09-21 16:22:32 字數 1197 閱讀 9394

目錄介紹部落格大彙總,持續更新目錄說明,記錄所有開源專案和部落格

如果那個專案好,可以star一下……

1.為什麼需要編碼規範?

2.包命名

例如: com.ycbjie.player

規約:包命名必須以com.ycbjie開始,後面跟有專案名稱(或者縮寫),再後面為模組名或層級名稱。

3.類和介面命名

4.方法的命名

5.變數命名

規約:變數命名也必須使用駝峰規則,但是首字母必須小寫,變數名盡可能的使用名詞或名詞片語。要求簡單易懂,不允許無意義的單詞。

如:string bookycname; 正確

如:string bookycnamestring; 錯誤!

6.成員變數命名

7.常量命名

8.異常命名

9.layout 命名

10.id 命名

11.資源命名

1.檔案注釋

/*

* 檔名

* 包含類名列表

* 版本資訊,版本號

* 建立日期。

*/

2.類注釋
/**

** author: yangchong

* blog : www.ycbjie.cn

* time : 2017/01/24

* desc : 載入工具類

* revise: 修改備註資訊

*

*/

3.方法注釋

/**

* 方法的一句話概述

* 方法詳述(簡單方法可不必詳述)

* @param s 說明引數含義

* @return 說明返回值含義

* @throws ioexception 說明發生此異常的條件

* @throws nullpointerexception 說明發生此異常的條件

*/

4.類成員變數和常量注釋

5.其他注釋

6.xml注釋1.縮排

2.空行

規約:通常在 變數宣告區域之後要用空行分隔,常量宣告區域之後要有空行 分隔,方法宣告之前要有空行分隔。

3.行寬4.1 版本更新情況

4.2 參考鏈結

4.2 個人部落格

Android編碼規範

1.變數命名 以google變數命名為規範,以小寫m為字首 變數英文含義。如 int mtitlecolor 標題顏色 2.常量命名 使用全大寫字母加下劃線的方式命名。如 static final int max running users 3 3.控制項命名 以小m為字首 控制項名稱縮寫 英文含義...

Android專案及編碼的規範

在開發中,遵循良好的編碼規範,不僅僅可以提高 的可讀性,減小出錯的可能性,同時也降低與其他開發者交流的成本,易於他人的維護與協作。本文簡單總結了android開發中的一些 規範,供開發者參考。除了注釋,中不出現中文 每個類寫上必要的注釋,類的說明,作者,方法加上必要的注釋說明,方便以後維護 1 ba...

php 編碼規範哪些 php編碼規範

1.php 必須以完整的形式來定界 即不要使用php 短標籤 且保證在關閉標籤後不要有任何空格。2.當乙個字串是純文字組成的時候 即不含有變數 則必須總是以單引號 作為定界符。例如 a example string 3.變數替換中的變數只允許用 變數名 的形式。例如 greeting hello n...