《程序開發(fā)規(guī)范》

1、1.1. 程序開發(fā)標(biāo)準(zhǔn)1.1.1. 目的定義這個(gè)標(biāo)準(zhǔn)的目的是讓工程中所有的文檔都看起來像一個(gè)人寫的， 增加可讀性， 減少工程組中因?yàn)閾Q人而帶來的損失。1.1.2. 命名標(biāo)準(zhǔn)Package 的命名Package 的名字應(yīng)該都是由一個(gè)小寫單詞組成，如： package com.wholewise.ucss.workflow ；。在UCSS工程中，我們對(duì)所有的包做如下規(guī)定：package com.wholewise.ucss.*;其中， * 是開發(fā)人員根據(jù)模塊自己定義的。Class 的命名Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成， 最好用有意義的單詞命 名。如： class G

2、etTreeInfo,class TransToXml 等。Class 變量的命名類對(duì)象的名字必須用一個(gè)小寫字母開頭。后面的單詞用大寫字母開頭。數(shù)據(jù)類型的變量第一個(gè)字母為變量類型的縮寫。如：sPassword,iCount 。關(guān)于數(shù)據(jù)類型標(biāo)識(shí)的說明(弱化該要求，盡量保持)數(shù)據(jù)類型數(shù)據(jù)類型標(biāo)識(shí)數(shù)據(jù)類型數(shù)據(jù)類型標(biāo)識(shí)整型(int)i浮點(diǎn)型(float)f字符串型(String)s字符型(char)c浮點(diǎn)型(double)d布爾型(boolean)b長整型(Iong)l數(shù)組(Array)aStrin gBuffersb二維數(shù)組aaStatic Fin al變量的命名Static Final變量的名字應(yīng)

3、該都大寫，并且指出完整含義。女口： private static final int SERVER_PORT=7100；/ 表示效勞器端口號(hào)。參數(shù)的命名參數(shù)的名字必須和變量的命名標(biāo)準(zhǔn)一致。數(shù)組的命名數(shù)組應(yīng)該總是用下面的方式來命名：byte aBuffer; 而不是：byte aBuffer;方法的命名使用有意義的參數(shù)命名，原那么上是動(dòng)詞+名詞。且除第一個(gè)單詞外其他單詞的第一個(gè)字母大寫。如果可能的話，使用和要賦值的字段一樣的名字：public void setSize(int iSize)this.iSize = iSize;public int getSize()return this.iSi

4、ze;1.1.3. Java 文件樣式所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)那么。信息信息必須在 java 文件的開頭，比方：/* Copyright ? 2001 WholeWise Sci.&Tech.Co.,Ltd* All right reserved.* MODIFIED (YYYY-MM-DD)* V1.0.0.0 developer 2000-01-01created * V1.0.0.1 changer 2000-02-01modified*/其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。Package/Import而且按照字* 來處理

5、。package 行要在 import 行之前， import 中標(biāo)準(zhǔn)的包名要在本地的包名之前， 母順序排列。如果 import 行中包含了同一個(gè)包中的不同子目錄，那么應(yīng)該用package com.wholewise.ywzx;import java.io.*;import java.util.Observable;import com.wholewise.ucss.tool.UseJolt;這里 java.io.* 使用來代替 InputStream and OutputStream的。如果你能確定你要調(diào)用包中的哪一個(gè)類，指明具體的類會(huì)更好。如：import java.io. InputSt

6、ream;import java.io. OutputStream;import java.util.Observable;import com.wholewise.ucss.tool.UseJolt;這樣運(yùn)行速度會(huì)更快些，查錯(cuò)也方便。Class接下來的是類的注釋，一般是用來解釋類的。定義的成員可以簡*/接下來是類定義，public class CounterSetextends Observableimplements Cloneable；Class Fields接下來是類的成員變量：protected int iSize;public 的成員變量必須生成文檔( JavaDoc)。 proc

7、eted 、private 和 package 變量如果名字含義明確的話，可以沒有注釋。構(gòu)造函數(shù)接下來是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫(比方：參數(shù)多的寫在后面) 。Public SetSize(int iSize)this.iSize = iSize;存取方法接下來是類變量的存取的方法。 如果它只是簡單的用來將類的變量賦值獲取值的話， 單的寫在一行上。public int getPackets() return copyArray(packets, offset); public int getBytes() return copyArray(bytes, offset); public int getPackets() return aPackets; public void setPackets(int aPackets) this.aPackets = aPackets; 5 / 6其它的方法不要寫在一行上類方法下面開始寫類的方法：/* 參見 3.7.1 的注釋說明*/protected finalString displayTreeInfo(String sNode)方法的注釋對(duì)于方法注釋，一般情況下是對(duì)一