編碼規(guī)范以開發(fā)手冊(cè)(編輯修改稿)
2025-05-04 22:07 本頁(yè)面
【文章內(nèi)容簡(jiǎn)介】 . 內(nèi)部類的注釋 類注釋。. 其它的注釋. 代碼修改的注釋若要修改單行代碼，請(qǐng)?jiān)谏弦恍惺褂脝涡凶⑨?，寫明修改原因，人員姓名和日期。并且用單行注釋符號(hào)注釋原行代碼。在下一行添加更新的代碼。如下：//初始值設(shè)置錯(cuò)誤。WangGang 20011218//String showMessage = null。String showMessage = “歡迎訪問(wèn)！”。說(shuō)明：這種注釋主要是針對(duì)以下幾種情況而言的：l 嚴(yán)重bug的修改l 版本相對(duì)穩(wěn)定后代碼的修改l 修改別人的代碼. 冗余代碼的注釋若在測(cè)試或者維護(hù)的過(guò)程中發(fā)現(xiàn)冗余的程序代碼，請(qǐng)注釋冗余的代碼行。并且在該代碼的前一行注明注釋原因，注釋人員姓名和注釋日期。注釋符號(hào)的選擇參照 代碼修改的注釋。. 類體外的注釋類體外主要包括 package 和 import 語(yǔ)句。若在測(cè)試或者維護(hù)的過(guò)程中需要為類添加新的功能，往往需要引入新的類包。在引入新的類包的同時(shí)不需要指定引入人及日期等Log 信息。多余的類包可以直接刪除。. 類類的組織順序建議如下順序：l 類的定義l 類的成員變量(字段/屬性)l 類成員變量(字段/屬性)的存取方法l 構(gòu)造函數(shù)l 類的方法l main()方法. 類的定義包含了在不同的行的 extends 和 implements public class CounterSet extends Observable implements Cloneable. 類的成員變量(字段/屬性)接下來(lái)是類的成員變量：/*** Packet counters*/protected int[] packets。. 類成員變量(字段/屬性)的存取方法接下來(lái)是類變量的存取的方法。 /** * Get the counters * @return an array containing the statistical data. This array has been * freshly allocated and can be modified by the caller. */public int[] getPackets() { return copyArray(packets, offset)。}public int[] getPackets() { return packets。 }public void setPackets(int[] packets) { = packets。 }. 構(gòu)造函數(shù) 接下來(lái)是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫（比如：參數(shù)多的寫在后面）。public CounterSet(int size){ = size。}. 類方法(靜態(tài)方法)下面開始寫類方法：/** * Set the packet counters * (such as when restoring from a database) */protected static void setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException{ // Ensure the arrays are of equal size if ( != || != || != ) throw new IllegalArgumentException(Arrays must be of the same size)。 (r1, 0, r3, 0, )。 (r2, 0, r4, 0, )。} . 實(shí)例方法實(shí)例方法一般如下定義：/** * Set the packet counters * (such as when restoring from a database) */protected void setArray(int[] r1, int[] r2, int[] r3, int[] r4) throws IllegalArgumentException{ // Ensure the arrays are of equal size if ( != || != || != ) throw new IllegalArgumentException(Arrays must be of the same size)。 (r1, 0, r3, 0, )。 (r2, 0, r4, 0, )。}有必要時(shí)，須加上final修飾符，表示本方法不可被覆蓋。. main方法 如果main(String[] args) 方法已經(jīng)定義了, 那么它應(yīng)該寫在類的底部 pulic static void main(String[] args) {……}. 接口接口的定義形式類似于類的定義形式。接口的聲明采用如下的格式：[public] interface InterfaceName [extends SuperInterfaces] {InterfaceBody}SuperInterfaces是可用逗號(hào)分隔的接口列表（如果超過(guò)一個(gè)接口），按照字母的順序排列。接口的聲明應(yīng)從第一列開始，“{” 應(yīng)該單獨(dú)占用一行，然后是接口體的定義，開頭要有縮進(jìn)，結(jié)束時(shí) “}” 應(yīng)該單獨(dú)占一行，且為第一列。. 接口體的組織接口體的聲明按照建議按如下順序：接口的字段聲明，接口方法聲明。接口字段聲明和方法聲明同類的字段和方法的聲明的形式一樣。. 語(yǔ)句. 簡(jiǎn)單語(yǔ)句. 賦值和表達(dá)式每行只包含一條語(yǔ)句。例如：a = b + c。 // RIGHTcount++。 // RIGHTa = b + c。 count++。 // NOT GOOD. 本地變量聲明本地變量的聲明應(yīng)在不同的行中，如果本地變量聲明后不再變動(dòng)應(yīng)當(dāng)聲明為final，使編譯器生成更有效率的代碼。例如：int j = 4。 // RIGHTint i, k。 // ACCEPTABLEint i, j = 4, k。 // NOT GOOD. 數(shù)組的聲明數(shù)組的[]應(yīng)該緊跟類型名，而不是數(shù)組名。在“[”之前不能有空格。例如：char buf[]。 // NOT GOODchar[] buf。 // GOODString[] getNames() { // RIGHT, method return value. return語(yǔ)句return語(yǔ)句后面的返回值不可以用括號(hào)包起來(lái)，除非是后面所跟為一個(gè)表達(dá)式。例如：return(true)。 // WRONGreturn true。 // RIGHTreturn (() + )。 // RIGHT. 復(fù)合語(yǔ)句. 括號(hào)的格式復(fù)合語(yǔ)句是一個(gè)語(yǔ)句塊被封裝在{}中。所有的復(fù)合語(yǔ)句建議采用如下的花括號(hào)形式：{} 中的語(yǔ)句應(yīng)該單獨(dú)作為一行。例如：if (i0) { i ++ } // RIGHT, “{” 單獨(dú)作為一行 if (i0) { i ++ }。 //NOT GOOD, “{” 和 “}” 在同一行 l 在 {} 中的復(fù)合語(yǔ)句應(yīng)該有層次。l 如下的情況可以不使用花括號(hào)：l 語(yǔ)句塊中包含 null 語(yǔ)句，或者只有簡(jiǎn)單的一行。注：有些IDE工具的默認(rèn)設(shè)置“{”是在行尾，請(qǐng)修改IDE工具設(shè)置，使“{”換行顯示。. if語(yǔ)句if(condition) {statements。}if (condition) {statements。}else {statements。}. for語(yǔ)句for (initialization。 condition。 update) {statements。}. while語(yǔ)句while (condition) {statements。}如使用無(wú)限循環(huán)，那么建議使用：while (true) {statements。}. dowhile語(yǔ)句do {statements。}while (condition)。. switch語(yǔ)句swit
公司管理相關(guān)推薦
鄂ICP備17016276號(hào)-1