建站
咨詢
售后
建站咨詢
新聞中心
java軟件開(kāi)發(fā)的代碼規(guī)范
1、組織與風(fēng)格
創(chuàng)新互聯(lián)服務(wù)項(xiàng)目包括龍港網(wǎng)站建設(shè)、龍港網(wǎng)站制作、龍港網(wǎng)頁(yè)制作以及龍港網(wǎng)絡(luò)營(yíng)銷策劃等。多年來(lái)，我們專注于互聯(lián)網(wǎng)行業(yè)，利用自身積累的技術(shù)優(yōu)勢(shì)、行業(yè)經(jīng)驗(yàn)、深度合作伙伴關(guān)系等，向廣大中小型企業(yè)、政府機(jī)構(gòu)等提供互聯(lián)網(wǎng)行業(yè)的解決方案，龍港網(wǎng)站推廣取得了明顯的社會(huì)效益與經(jīng)濟(jì)效益。目前，我們服務(wù)的客戶以成都為中心已經(jīng)輻射到龍港省份的部分城市，未來(lái)相信會(huì)繼續(xù)擴(kuò)大服務(wù)區(qū)域并繼續(xù)獲得客戶的支持與信任！
(1).關(guān)鍵詞和操作符之間加適當(dāng)?shù)目崭瘛?/p>
(2).相對(duì)獨(dú)立的程序塊與塊之間加空行
(3).較長(zhǎng)的語(yǔ)句、表達(dá)式等要分成多行書寫。
(4).劃分出的新行要進(jìn)行適應(yīng)的縮進(jìn)，使排版整齊，語(yǔ)句可讀。
(5).長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。
(6).循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分。
(7).若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐帧?/p>
(8).不允許把多個(gè)短語(yǔ)句寫在一行中，即一行只寫一條語(yǔ)句。
(9).函數(shù)或過(guò)程的開(kāi)始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格。
注：如果大家有興趣可以到安安DIY創(chuàng)作室博客，有相關(guān)說(shuō)明性的文章和解釋。
2、注解
Java 的語(yǔ)法與 C++ 及為相似，那么，你知道 Java 的注釋有幾種嗎？是兩種？
// 注釋一行
/* ...... */ 注釋若干行
不完全對(duì)，除了以上兩種之外，還有第三種，文檔注釋：
/** ...... */ 注釋若干行，并寫入 javadoc 文檔
注釋要簡(jiǎn)單明了。
String userName = null; //用戶名
邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。
在必要的地方注釋，注釋量要適中。注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。
保持注釋與其描述的代碼相鄰，即注釋的就近原則。
對(duì)代碼的注釋應(yīng)放在其上方相鄰位置，不可放在下面。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋應(yīng)放在此域的右方；
同一結(jié)構(gòu)中不同域的注釋要對(duì)齊。
變量、常量的注釋應(yīng)放在其上方相鄰位置或右方。
全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。
在每個(gè)源文件的頭部要有必要的注釋信息，包括：文件名；版本號(hào)；作者；生成日期；模塊功能描述（如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過(guò)程清單及本文件歷史修改記錄等。
/**
* Copy Right Information : Neusoft IIT
* Project : eTrain
* JDK version used : jdk1.3.1
* Comments : config path
* Version : 1.01
* Modification history :2003.5.1
* Sr Date Modified By Why What is modified
* 1. 2003.5.2 Kevin Gao new
**/
在每個(gè)函數(shù)或過(guò)程的前面要有必要的注釋信息，包括：函數(shù)或過(guò)程名稱；功能描述；輸入、輸出及返回值說(shuō)明；調(diào)用關(guān)系及被調(diào)用關(guān)系說(shuō)明等
/**
* Description :checkout 提款
* @param Hashtable cart info
* @param OrderBean order info
* @return String
*/
public String checkout(Hashtable htCart,
OrderBean orderBean)
throws Exception{
}
javadoc注釋標(biāo)簽語(yǔ)法
@author 對(duì)類的說(shuō)明 標(biāo)明開(kāi)發(fā)該類模塊的作者
@version 對(duì)類的說(shuō)明 標(biāo)明該類模塊的版本
@see 對(duì)類、屬性、方法的說(shuō)明 參考轉(zhuǎn)向，也就是相關(guān)主題
@param 對(duì)方法的說(shuō)明 對(duì)方法中某參數(shù)的說(shuō)明
@return 對(duì)方法的說(shuō)明 對(duì)方法返回值的說(shuō)明
@exception 對(duì)方法的說(shuō)明 對(duì)方法可能拋出的異常進(jìn)行說(shuō)明
3、命名規(guī)范
定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫的，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。（這些規(guī)范并不是一定要絕對(duì)遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過(guò)去掉元音形成縮寫；要不然最后自己寫的代碼自己都看不懂了，那可不行。
較長(zhǎng)的單詞可取單詞的頭幾發(fā)符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。
使用匈牙利表示法
Package 的命名
Package 的名字應(yīng)該都是由一個(gè)小寫單詞組成。
package com.neu.util
Class 的命名
Class 的名字必須由大寫字母開(kāi)頭而其他字母都小寫的單詞組成,對(duì)于所有標(biāo)識(shí)符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。
public class ThisAClassName{}
Class 變量的命名
變量的名字必須用一個(gè)小寫字母開(kāi)頭。后面的單詞用大寫字母開(kāi)頭
userName , thisAClassMethod
Static Final 變量的命名
static Final 變量的名字應(yīng)該都大寫，并且指出完整含義。
/**
*DBConfig PATH
**/
public static final String
DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;
參數(shù)的命名
參數(shù)的名字必須和變量的命名規(guī)范一致。
數(shù)組的命名
數(shù)組應(yīng)該總是用下面的方式來(lái)命名：
byte[] buffer;
而不是：
byte buffer[];
方法的參數(shù)
使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名字：
SetCounter(int size){
this.size = size;
}
4、文件樣式
所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則：
版權(quán)信息
版權(quán)信息必須在 java 文件的開(kāi)頭，比如：
/*
* Copyright ? 2000 Shanghai XXX Co. Ltd.
* All right reserved.
*/
其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。
Package/Imports
package 行要在 import 行之前，import 中標(biāo)準(zhǔn)的包名要在本地的包名之前，而且按照字母
順序排列。如果 import 行中包含了同一個(gè)包中的不同子目錄，則應(yīng)該用 * 來(lái)處理。
package hotlava.net.stats;
import java io.*;
import java.util.Observable;
import hotlava.util.Application;
這里 java。io.* 使用來(lái)代替InputStream and OutputStream 的。
Class
接下來(lái)的是類的注釋，一般是用來(lái)解釋類的。
/**
* A class representing a set of packet and byte counters
* It is observable to allow it to be watched, but only
* reports changes when the current set is complete
*/
接下來(lái)是類定義，包含了在不同的行的 extends 和 implements
public class CounterSet
extends Observable
implements Cloneable
Class Fields
接下來(lái)是類的成員變量：
/**
* Packet counters
*/
protected int[] packets;
public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義的成
員變量如果名字含義明確的話，可以沒(méi)有注釋。
存取方法
接下來(lái)是類變量的存取的方法。它只是簡(jiǎn)單的用來(lái)將類的變量賦值獲取值的話，可以簡(jiǎn)單的
寫在一行上。
/**
* 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[] getBytes() { return copyArray(bytes, offset); }
public int[] getPackets() { return packets; }
public void setPackets(int[] packets) { this.packets = packets; }
其它的方法不要寫在一行上
構(gòu)造函數(shù)
接下來(lái)是構(gòu)造函數(shù)，它應(yīng)該用遞增的方式寫（比如：參數(shù)多的寫在后面）。
訪問(wèn)類型 (public, private 等.) 和 任何 static, final 或 synchronized 應(yīng)該在一行
中，并且方法和參數(shù)另寫一行，這樣可以使方法和參數(shù)更易讀。
public
CounterSet(int size){
this.size = size;
}
克隆方法
如果這個(gè)類是可以被克隆的，那么下一步就是 clone 方法：
public
Object clone() {
try {
CounterSet obj = (CounterSet)super.clone();
obj.packets = (int[])packets.clone();
obj.size = size;
return obj;
}catch(CloneNotSupportedException e) {
throw new InternalError(Unexpected CloneNotSUpportedException: +
e.getMessage());
}
}
類方法
下面開(kāi)始寫類的方法：
/**
* Set the packet counters
* (such as when restoring from a database)
*/
protected final
void setArray(int[] r1, int[] r2, int[] r3, int[] r4)
throws IllegalArgumentException
{
//
// Ensure the arrays are of equal size
//
if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)
throw new IllegalArgumentException(Arrays must be of the same size);
System.arraycopy(r1, 0, r3, 0, r1.length);
System.arraycopy(r2, 0, r4, 0, r1.length);
}
toString 方法
無(wú)論如何，每一個(gè)類都應(yīng)該定義 toString 方法：
public
String toString() {
String retval = CounterSet: ;
for (int i = 0; i data.length(); i++) {
retval += data.bytes.toString();
retval += data.packets.toString();
}
return retval;
}
}
main 方法
如果main(String[]) 方法已經(jīng)定義了, 那么它應(yīng)該寫在類的底部.
5、代碼可讀性
避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來(lái)替代。
不要使用難懂的技巧性很高的語(yǔ)句。
源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。
6、代碼性能
在寫代碼的時(shí)候，從頭至尾都應(yīng)該考慮性能問(wèn)題。這不是說(shuō)時(shí)間都應(yīng)該浪費(fèi)在優(yōu)化代碼上，而是我們時(shí)刻應(yīng)該提醒自己要注意代碼的效率。比如：如果沒(méi)有時(shí)間來(lái)實(shí)現(xiàn)一個(gè)高效的算法，那么我們應(yīng)該在文檔中記錄下來(lái)，以便在以后有空的時(shí)候再來(lái)實(shí)現(xiàn)她。
不是所有的人都同意在寫代碼的時(shí)候應(yīng)該優(yōu)化性能這個(gè)觀點(diǎn)的，他們認(rèn)為性能優(yōu)化的問(wèn)題應(yīng)該在項(xiàng)目的后期再去考慮，也就是在程序的輪廓已經(jīng)實(shí)現(xiàn)了以后。
不必要的對(duì)象構(gòu)造
不要在循環(huán)中構(gòu)造和釋放對(duì)象
使用 StringBuffer 對(duì)象
在處理 String 的時(shí)候要盡量使用 StringBuffer 類，StringBuffer 類是構(gòu)成 String 類的基礎(chǔ)。
String 類將 StringBuffer 類封裝了起來(lái)，（以花費(fèi)更多時(shí)間為代價(jià)）為開(kāi)發(fā)人員提供了一個(gè)安全的接口。當(dāng)我們?cè)跇?gòu)造字符串的時(shí)候，我們應(yīng)該用 StringBuffer 來(lái)實(shí)現(xiàn)大部分的工作，當(dāng)工作完成后將 StringBuffer 對(duì)象再轉(zhuǎn)換為需要的 String 對(duì)象。比如：如果有一個(gè)字符串必須不斷地在其后添加許多字符來(lái)完成構(gòu)造，那么我們應(yīng)該使用StringBuffer 對(duì)象和她的 append() 方法。如果我們用 String 對(duì)象代替StringBuffer 對(duì)象的話，會(huì)花費(fèi)許多不必要的創(chuàng)建和釋放對(duì)象的 CPU 時(shí)間。大家可以來(lái)安安DIY創(chuàng)作室一起討論。
避免太多的使用 synchronized 關(guān)鍵字避免不必要的使用關(guān)鍵字 synchronized，應(yīng)該在必要的時(shí)候再使用她，這是一個(gè)避免死鎖的好方法。
7、編程技巧
byte 數(shù)組轉(zhuǎn)換到 characters
為了將 byte 數(shù)組轉(zhuǎn)換到 characters，你可以這么做：
Hello world!.getBytes();
Utility 類
Utility 類（僅僅提供方法的類）應(yīng)該被申明為抽象的來(lái)防止被繼承或被初始化。
初始化
下面的代碼是一種很好的初始化數(shù)組的方法：
objectArguments = new Object[] { arguments };
枚舉類型
JAVA 對(duì)枚舉的支持不好，但是下面的代碼是一種很有用的模板：
class Colour {
public static final Colour BLACK = new Colour(0, 0, 0);
public static final Colour RED = new Colour(0xFF, 0, 0);
public static final Colour GREEN = new Colour(0, 0xFF, 0);
public static final Colour BLUE = new Colour(0, 0, 0xFF);
public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);
}
這種技術(shù)實(shí)現(xiàn)了RED, GREEN, BLUE 等可以象其他語(yǔ)言的枚舉類型一樣使用的常量。
他們可以用 '==' 操作符來(lái)比較。
但是這樣使用有一個(gè)缺陷：如果一個(gè)用戶用這樣的方法來(lái)創(chuàng)建顏色 BLACK new Colour(0,0,0)
那么這就是另外一個(gè)對(duì)象，'=='操作符就會(huì)產(chǎn)生錯(cuò)誤。她的 equal() 方法仍然有效。由于這個(gè)原因，這個(gè)技術(shù)的缺陷最好注明在文檔中，或者只在自己的包中使用。
8、編寫格式
代碼樣式
代碼應(yīng)該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）
文檔化
必須用 javadoc 來(lái)為類生成文檔。不僅因?yàn)樗菢?biāo)準(zhǔn)，這也是被各種 java 編譯器都認(rèn)可的方法。使用 @author 標(biāo)記是不被推薦的，因?yàn)榇a不應(yīng)該是被個(gè)人擁有的。
縮進(jìn)
縮進(jìn)應(yīng)該是每行2個(gè)空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時(shí)Tab字符將因?yàn)橛脩粼O(shè)置的不同而擴(kuò)展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過(guò)如下操作來(lái)禁止保存Tab字符, 方法是通過(guò) UltrEdit中先設(shè)定 Tab 使用的長(zhǎng)度室2個(gè)空格，然后用 Format|Tabs to Spaces 菜單將 Tab 轉(zhuǎn)換為空格。
頁(yè)寬
頁(yè)寬應(yīng)該設(shè)置為80字符. 源代碼一般不會(huì)超過(guò)這個(gè)寬度, 并導(dǎo)致無(wú)法完整顯示, 但這一設(shè)置也可以靈活調(diào)整. 在任何情況下, 超長(zhǎng)的語(yǔ)句應(yīng)該在一個(gè)逗號(hào)或者一個(gè)操作符后折行. 一條語(yǔ)句折行后, 應(yīng)該比原來(lái)的語(yǔ)句再縮進(jìn)2個(gè)字符.
{} 對(duì)
{} 中的語(yǔ)句應(yīng)該單獨(dú)作為一行. 例如, 下面的第1行是錯(cuò)誤的, 第2行是正確的:
if (i0) { i ++ }; // 錯(cuò)誤, { 和 } 在同一行
if (i0) {
i ++
}; // 正確, { 單獨(dú)作為一行
} 語(yǔ)句永遠(yuǎn)單獨(dú)作為一行.如果 } 語(yǔ)句應(yīng)該縮進(jìn)到與其相對(duì)應(yīng)的 { 那一行相對(duì)齊的位置。
括號(hào)
左括號(hào)和后一個(gè)字符之間不應(yīng)該出現(xiàn)空格, 同樣, 右括號(hào)和前一個(gè)字符之間也不應(yīng)該出現(xiàn)空格. 下面的例子說(shuō)明括號(hào)和空格的錯(cuò)誤及正確使用:
CallProc( AParameter ); // 錯(cuò)誤
CallProc(AParameter); // 正確
不要在語(yǔ)句中使用無(wú)意義的括號(hào). 括號(hào)只應(yīng)該為達(dá)到某種目的而出現(xiàn)在源代碼中。下面的例子說(shuō)明錯(cuò)誤和正確的用法:
if ((I) = 42) { // 錯(cuò)誤 - 括號(hào)毫無(wú)意義
if (I == 42) or (J == 42) then // 正確 - 的確需要括號(hào)
9、代碼編譯
1.編寫代碼時(shí)要注意隨時(shí)保存，并定期備份，防止由于斷電、硬盤損壞等原因造成代碼丟失。
2.同一項(xiàng)目組內(nèi)，最好使用相同的編輯器，并使用相同的設(shè)置選項(xiàng)。
3.合理地設(shè)計(jì)軟件系統(tǒng)目錄，方便開(kāi)發(fā)人員使用。
4.打開(kāi)編譯器的所有告警開(kāi)關(guān)對(duì)程序進(jìn)行編譯。
5.在同一項(xiàng)目組或產(chǎn)品組中，要統(tǒng)一編譯開(kāi)關(guān)選項(xiàng)。
6.使用工具軟件（如Visual SourceSafe）對(duì)代碼版本進(jìn)行維護(hù)。如果大家有不明白的可以到安安DIY創(chuàng)作室留言。
10、可移植性
Borland Jbulider 不喜歡 synchronized 這個(gè)關(guān)鍵字，如果你的斷點(diǎn)設(shè)在這些關(guān)鍵字的作用域內(nèi)的話，調(diào)試的時(shí)候你會(huì)發(fā)現(xiàn)的斷點(diǎn)會(huì)到處亂跳，讓你不知所措。除非必須，盡量不要使用。
換行
如果需要換行的話，盡量用 println 來(lái)代替在字符串中使用\n。
你不要這樣：
System.out.print(Hello,world!\n);
要這樣：
System.out.println(Hello,world!);
或者你構(gòu)造一個(gè)帶換行符的字符串，至少要象這樣：
String newline = System.getProperty(line.separator);
System.out.println(Hello world + newline);
PrintStream
PrintStream 已經(jīng)被不贊成（deprecated）使用，用 PrintWrite 來(lái)代替它。
java中如何設(shè)定new template
方法/步驟
1、點(diǎn)擊菜單欄的“Window”-“Preferences”，打開(kāi)“Preferences”對(duì)話框。
2、在Preferences”對(duì)話框中點(diǎn)擊“Java”-“Editor”-“Templates”。
3、然后在有面窗口中，點(diǎn)擊“New”，彈出“New Template”對(duì)話框，在里面我們可以設(shè)置自定義的代碼模板的名字以及代碼的具體內(nèi)容。比如：我定義了一個(gè)叫做tsleep的模板，當(dāng)輸入tsleep，并按下alt+/的時(shí)候，編輯器會(huì)自動(dòng)替換成：
try{
Thread.sleep(1000);
}catch(Exception e){
e.printStackTrace();
}
并且會(huì)把鼠標(biāo)插入到1000的后面。
4、注意上圖中輸入的${cursor}，這是通過(guò)點(diǎn)擊“Insert Variable...“插入光標(biāo)。還有更多的選項(xiàng)，可以自己嘗試下。
5、在Eclispe中新建一個(gè)Java源文件，然后輸入tsleep，編輯器會(huì)自動(dòng)替換成：
try {
Thread.sleep(1000);
} catch (Exception e) {
e.printStackTrace();
}
補(bǔ)充：Java是一種可以撰寫跨平臺(tái)應(yīng)用程序的面向?qū)ο蟮某绦蛟O(shè)計(jì)語(yǔ)言。Java 技術(shù)具有卓越的通用性、高效性、平臺(tái)移植性和安全性，廣泛應(yīng)用于PC、數(shù)據(jù)中心、游戲控制臺(tái)、科學(xué)超級(jí)計(jì)算機(jī)、移動(dòng)電話和互聯(lián)網(wǎng)，同時(shí)擁有全球最大的開(kāi)發(fā)者專業(yè)社群。
Office Word中想插入一段Java(或其它語(yǔ)言)的代碼，有什么好的代碼模板？
打開(kāi)word文檔，插入，對(duì)象，新建，OpenDocument文本，這里等待粘入代碼。
在VS2017或者其他IDE或者notpad++，例如，我用了notpad++，選擇（插件）Plugins→NppExport→Copy all formats to clipboard，然后粘貼過(guò)去，即可。
麻煩那位大神幫幫忙，曬下你們的JAVA代碼。非常感謝
public static void main(String[] args) {
File f = new File("E:\\xx\\xxx");
String[] name = f.list(new FilenameFilter() {
public boolean accept(File dir,String name){
return name.indexOf(".java")!=-1;
}
});
for(int i=0;iname.length;i++)
System.out.println(name[i]);
}
//運(yùn)行結(jié)果
xxx - 副本 - 副本 (2).java
xxx - 副本 - 副本 (3).java
xxx - 副本 - 副本 (4).java
xxx - 副本 - 副本 (5).java
xxx - 副本 - 副本 (6).java
xxx - 副本 - 副本 (7).java
xxx - 副本 - 副本.java
xxx - 副本.java
xxx.java
//文件在E盤的xx文件夾中的xxx文件夾下。
名稱欄目：java高級(jí)代碼模板 java高質(zhì)量代碼
分享網(wǎng)址：http://ef60e0e.cn/article/dogejjp.html
