java編碼規範 空白和命名規範

2021-08-25 00:25:02 字數 3596 閱讀 6719

1.

空白(white space)

7.1空行

(blank lines)

空行將邏輯相關的**段分隔開,以提高可讀性。下列情況應該總是使用兩個空行:

·乙個原始檔的兩個片段(section)之間

·類宣告和介面宣告之間

下列情況應該總是使用乙個空行:

·兩個方法之間

·方法內的區域性變數和方法的第一條語句之間

·塊注釋(參見"5.1.1"

)或單行注釋(參見"5.1.2"

)之前

·乙個方法內的兩個邏輯段之間,用以提高可讀性

7.2空格(blank spaces)

下列情況應該使用空格:

乙個緊跟著括號的關鍵字應該被空格分開,例如:

while (true)

注意:空格不應該置於方法名與其左括號之間。這將有助於區分關鍵字和方法呼叫。

空格應該位於引數列表中逗號的後面

所有的二元運算子,除了"."

,應該使用空格將之與運算元分開。一元操作符和運算元之間不因該加空格,比如:負號("-")

、自增("++")

和自減("--")

。例如:

a += c + d;

a = (a + b) / (c * d);

while (d++ = s++)

printsize("size is " + foo + "\n");

for語句中的表示式應該被空格分開,例如:

for (expr1; expr2; expr3)

強制轉型後應該跟乙個空格,例如:

mymethod((byte) anum, (object) x);

mymethod((int) (cp + 5), ((int) (i + 3)) + 1);

2.命名規範

(naming conventions)

命名規範使程式更易讀,從而更易於理解。它們也可以提供一些有關識別符號功能的資訊,以助於理解**。定義這個規範的目的是讓專案中所有的文件都看起來像乙個人寫的,增加可讀性,減少專案開發過程中因更換人員而帶來的損失。較短的單詞可通過去掉「母音」形成縮寫;較長的單詞可取單詞的頭幾個字元或者通用的縮寫來實現單詞的簡化。

8.1

(packages)

乙個唯一包名的字首總是全部小寫的ascii

字母並且是乙個頂級網域名稱,通常是com

,edu

,gov

,mil

,net

,org

,或1981

年iso 3166

標準所指定的標識國家的英文雙字元**。包名的後續部分根據不同機構各自內部的命名規範而不盡相同。這類命名規範可能以特定目錄名的組成來區分部門(department)

,專案(project)

,機器(machine)

,或註冊名(login names)

,如:com.itcenter.models

8.2

(classes)

命名規則:類名是個名詞,採用大小寫混合的方式,對於所有識別符號,其中包含的所有單詞都應緊靠在一起,而且大寫中間單詞的首字母。盡量使你的類名簡潔而富於描述。使用完整單詞,避免縮寫詞(

除非該縮寫詞被更廣泛使用,像url

,html)

,如:public class wateranalysisview{}

8.3

介面(inte***ces)

命名規則:大小寫規則與類名相似,如:public inte***ce deptlogin {}

8.4

方法(method)

方法名是乙個動詞,採用大小寫混合的方式,第乙個單詞的首字母小寫,其後單詞的首字母大寫。如:run()

,getbackground();

8.5

變數(variable)

除了變數名外,所有例項,包括類,類常量,均採用大小寫混合的方式,第乙個單詞的首字母小寫,其後單詞的首字母大寫。變數名不應以下劃線或美元符號開頭,儘管這在語法上是允許的。變數名應簡短且富於描述。變數名的選用應該易於記憶,且易於望名而生其意。盡量避免單個字元的變數名,除非是一次性的臨時變數。臨時變數通常被取名為i

,j,k

,m和n

,它們一般用於整型;c

,d,e

,它們一般用於字元型別。

char c;

int i;

float mywidth;

8.6

例項變數(instance variables)

大小寫規則和變數名相似,除了前面需要乙個下劃線

int _employeeid;

string _name;

customer _customer;

8.7

變數定義規範

1)去掉沒必要的公共變數。 2)

構造僅有乙個模組或函式可以修改、建立,而其餘有關模組或函式只訪問的公共變數,防止多個不同模組或函式都可以修改、建立同一公共變數的現象。 3)

仔細定義並明確公共變數的含義、作用、取值範圍及公共變數間的關係。 4)

明確公共變數與操作此公共變數的函式或過程的關係,如訪問、修改及建立等。 5)

當向公共變數傳遞資料時,要十分小心,防止賦與不合理的值或越界等現象發生。 6)

防止區域性變數與公共變數同名。 7)

仔細設計結構中元素的布局與排列順序,使結構容易理解、節省占用空間,並減少引起誤用現象。 8)

結構的設計要盡量考慮向前相容和以後的版本公升級,並為某些未來可能的應用保留餘地(如預留一些空間等)。 9)

留心具體語言及編譯器處理不同資料型別的原則及有關細節。

10)嚴禁使用未經初始化的變數。宣告變數的同時對變數進行初始化。

11)程式設計時,要注意資料型別的強制轉換。

8.8

常量(constants)

類常量和ansi

常量的宣告,應該全部大寫,單詞間用下劃線隔開。(

盡量避免ansi

常量,容易引起錯誤)

static final int min_width = 4;

static final int max_width = 999;

static final int get_the_cpu = 1;

IOS編碼規範(命名規範)

一.命名規則 命名總則 1.使 用駝峰法命名,命名清晰明了,要做到 自描述,不能省略,部分cocoa通 用縮略詞能夠縮寫。objective c不 支援名字命名空間,所以某些命名要加項 目前綴區別。需要加字首的地 方 全域性變數,類名,全域性函式,category 每個類別,函式都必須新增字首 3....

Java編碼規範之宣告和空白,空格

6 宣告 declarations 6.1 每行宣告變數的數量 number per line 推薦一行乙個宣告,因為這樣以利於寫注釋。亦即,int level indentation level int size size of table 要優於,int level,size 不要將不同型別變數...

Python編碼規範之命名規範

1 不要使用小寫字母 l el 大寫字母 o oh 或者小寫 i 作為單獨變數名稱。因為一些字型中,上訴字母和數字很難區分 比如 o和0,l和1 2 module應該採用全小寫,並且盡可能短的命名,可以在模組名中使用下劃線以提高可讀性。package應該採用全部小寫,並且也要盡可能短的命名,但不允許...