《程序開發(fā)規(guī)范》_第1頁
《程序開發(fā)規(guī)范》_第2頁
《程序開發(fā)規(guī)范》_第3頁
免費預覽已結束,剩余1頁可下載查看

下載本文檔

版權說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權,請進行舉報或認領

文檔簡介

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

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

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

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

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

6、java.io. OutputStream;import java.util.Observable;import com.wholewise.ucss.tool.UseJolt;這樣運行速度會更快些,查錯也方便。Class接下來的是類的注釋,一般是用來解釋類的。* 描述這個類的功能*/接下來是類定義,public class CounterSet extends Observable implements Cloneable ;Class Fields接下來是類的成員變量:protected int iSize;public 的成員變量必須生成文檔 JavaDoc。 proceted、 pri

7、vate 和 package 定義的成員變量 如果名字含義明確的話,可以沒有注釋。構造函數(shù)接下來是構造函數(shù),它應該用遞增的方式寫比方:參數(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; 學習文檔 僅供參考其它的方法不要寫在一行上類方法下面開始寫類的方法:/* 參見 3.7.1 的注釋說明*/protected final String displayTreeInfo(String sNode)方法的注釋對于方法注釋,一般情況下是對一些

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預覽,若沒有圖紙預覽就沒有圖紙。
  • 4. 未經(jīng)權益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負責。
  • 6. 下載文件中如有侵權或不適當內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準確性、安全性和完整性, 同時也不承擔用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論