Java源代碼的頭和尾,JAVA源代碼是什么

java 怎樣給源代碼添加注釋

1、單行(single-line)--短注釋：//……

創(chuàng)新互聯(lián)建站是一家集網站建設,烏蘇企業(yè)網站建設,烏蘇品牌網站建設,網站定制,烏蘇網站建設報價,網絡營銷,網絡優(yōu)化,烏蘇網站推廣為一體的創(chuàng)新建站企業(yè)，幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強企業(yè)競爭力?？沙浞譂M足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網需求。同時我們時刻保持專業(yè)、時尚、前沿，時刻以成就客戶成長自我，堅持不斷學習、思考、沉淀、凈化自己，讓我們?yōu)楦嗟钠髽I(yè)打造出實用型網站。

單獨行注釋：在代碼中單起一行注釋，

注釋前最好有一行空行，并與其后的代碼具有一樣的縮進層級。如果單行無法完成，則應采用塊注釋。

注釋格式：/*

注釋內容

*/

行頭注釋：在代碼行的開頭進行注釋。主要為了使該行代碼失去意義。

注釋格式：//

注釋內容

行尾注釋：尾端(trailing)--極短的注釋，在代碼行的行尾進行注釋。一般與代碼行后空8（至少4）個格，所有注釋必須對齊。

注釋格式：代碼

+

8（至少4）個空格

+

//

注釋內容

2、塊(block)--塊注釋：/*……*/

注釋若干行，通常用于提供文件、方法、數(shù)據(jù)結構等的意義與用途的說明，或者算法的描述。一般位于一個文件或者一個方法的前面，起到引導的作用，也可以根據(jù)需要放在合適的位置。這種域注釋不會出現(xiàn)在HTML報告中。注釋格式通常寫成：

/*

*

注釋內容

*/

3、文檔注釋：/**……*/

注釋若干行，并寫入javadoc文檔。每個文檔注釋都會被置于注釋定界符

/**......*/

...

java軟件開發(fā)的代碼規(guī)范

1、組織與風格

(1).關鍵詞和操作符之間加適當?shù)目崭瘛?/p>

(2).相對獨立的程序塊與塊之間加空行

(3).較長的語句、表達式等要分成多行書寫。

(4).劃分出的新行要進行適應的縮進，使排版整齊，語句可讀。

(5).長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。

(6).循環(huán)、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分。

(7).若函數(shù)或過程中的參數(shù)較長，則要進行適當?shù)膭澐帧?/p>

(8).不允許把多個短語句寫在一行中，即一行只寫一條語句。

(9).函數(shù)或過程的開始、結構的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風格。

注：如果大家有興趣可以到安安DIY創(chuàng)作室博客，有相關說明性的文章和解釋。

2、注解

Java 的語法與 C++ 及為相似，那么，你知道 Java 的注釋有幾種嗎？是兩種？

// 注釋一行

/* ...... */ 注釋若干行

不完全對，除了以上兩種之外，還有第三種，文檔注釋：

/** ...... */ 注釋若干行，并寫入 javadoc 文檔

注釋要簡單明了。

String userName = null; //用戶名

邊寫代碼邊注釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。

在必要的地方注釋，注釋量要適中。注釋的內容要清楚、明了，含義準確，防止注釋二義性。

保持注釋與其描述的代碼相鄰，即注釋的就近原則。

對代碼的注釋應放在其上方相鄰位置，不可放在下面。對數(shù)據(jù)結構的注釋應放在其上方相鄰位置，不可放在下面；對結構中的每個域的注釋應放在此域的右方；

同一結構中不同域的注釋要對齊。

變量、常量的注釋應放在其上方相鄰位置或右方。

全局變量要有較詳細的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。

在每個源文件的頭部要有必要的注釋信息，包括：文件名；版本號；作者；生成日期；模塊功能描述（如功能、主要算法、內部各部分之間的關系、該文件與其它文件關系等）；主要函數(shù)或過程清單及本文件歷史修改記錄等。

/**

* 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

**/

在每個函數(shù)或過程的前面要有必要的注釋信息，包括：函數(shù)或過程名稱；功能描述；輸入、輸出及返回值說明；調用關系及被調用關系說明等

/**

* Description :checkout 提款

* @param Hashtable cart info

* @param OrderBean order info

* @return String

*/

public String checkout(Hashtable htCart,

OrderBean orderBean)

throws Exception{

}

javadoc注釋標簽語法

@author 對類的說明 標明開發(fā)該類模塊的作者

@version 對類的說明 標明該類模塊的版本

@see 對類、屬性、方法的說明 參考轉向，也就是相關主題

@param 對方法的說明 對方法中某參數(shù)的說明

@return 對方法的說明 對方法返回值的說明

@exception 對方法的說明 對方法可能拋出的異常進行說明

3、命名規(guī)范

定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。（這些規(guī)范并不是一定要絕對遵守，但是一定要讓程序有良好的可讀性）較短的單詞可通過去掉元音形成縮寫；要不然最后自己寫的代碼自己都看不懂了，那可不行。

較長的單詞可取單詞的頭幾發(fā)符的優(yōu)先級，并用括號明確表達式的操作順序，避免使用默認優(yōu)先級。

使用匈牙利表示法

Package 的命名

Package 的名字應該都是由一個小寫單詞組成。

package com.neu.util

Class 的命名

Class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成,對于所有標識符，其中包含的所有單詞都應緊靠在一起，而且大寫中間單詞的首字母。

public class ThisAClassName{}

Class 變量的命名

變量的名字必須用一個小寫字母開頭。后面的單詞用大寫字母開頭

userName , thisAClassMethod

Static Final 變量的命名

static Final 變量的名字應該都大寫，并且指出完整含義。

/**

*DBConfig PATH

**/

public static final String

DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;

參數(shù)的命名

參數(shù)的名字必須和變量的命名規(guī)范一致。

數(shù)組的命名

數(shù)組應該總是用下面的方式來命名：

byte[] buffer;

而不是：

byte buffer[];

方法的參數(shù)

使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字段一樣的名字：

SetCounter(int size){

this.size = size;

}

4、文件樣式

所有的 Java(*.java) 文件都必須遵守如下的樣式規(guī)則：

版權信息

版權信息必須在 java 文件的開頭，比如：

/*

* Copyright ? 2000 Shanghai XXX Co. Ltd.

* All right reserved.

*/

其他不需要出現(xiàn)在 javadoc 的信息也可以包含在這里。

Package/Imports

package 行要在 import 行之前，import 中標準的包名要在本地的包名之前，而且按照字母

順序排列。如果 import 行中包含了同一個包中的不同子目錄，則應該用 * 來處理。

package hotlava.net.stats;

import java io.*;

import java.util.Observable;

import hotlava.util.Application;

這里 java。io.* 使用來代替InputStream and OutputStream 的。

Class

接下來的是類的注釋，一般是用來解釋類的。

/**

* 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

*/

接下來是類定義，包含了在不同的行的 extends 和 implements

public class CounterSet

extends Observable

implements Cloneable

Class Fields

接下來是類的成員變量：

/**

* Packet counters

*/

protected int[] packets;

public 的成員變量必須生成文檔（JavaDoc）。proceted、private和 package 定義的成

員變量如果名字含義明確的話，可以沒有注釋。

存取方法

接下來是類變量的存取的方法。它只是簡單的用來將類的變量賦值獲取值的話，可以簡單的

寫在一行上。

/**

* 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; }

其它的方法不要寫在一行上

構造函數(shù)

接下來是構造函數(shù)，它應該用遞增的方式寫（比如：參數(shù)多的寫在后面）。

訪問類型 (public, private 等.) 和 任何 static, final 或 synchronized 應該在一行

中，并且方法和參數(shù)另寫一行，這樣可以使方法和參數(shù)更易讀。

public

CounterSet(int size){

this.size = size;

}

克隆方法

如果這個類是可以被克隆的，那么下一步就是 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());

}

}

類方法

下面開始寫類的方法：

/**

* 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 方法

無論如何，每一個類都應該定義 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[]) 方法已經定義了, 那么它應該寫在類的底部.

5、代碼可讀性

避免使用不易理解的數(shù)字，用有意義的標識來替代。

不要使用難懂的技巧性很高的語句。

源程序中關系較為緊密的代碼應盡可能相鄰。

6、代碼性能

在寫代碼的時候，從頭至尾都應該考慮性能問題。這不是說時間都應該浪費在優(yōu)化代碼上，而是我們時刻應該提醒自己要注意代碼的效率。比如：如果沒有時間來實現(xiàn)一個高效的算法，那么我們應該在文檔中記錄下來，以便在以后有空的時候再來實現(xiàn)她。

不是所有的人都同意在寫代碼的時候應該優(yōu)化性能這個觀點的，他們認為性能優(yōu)化的問題應該在項目的后期再去考慮，也就是在程序的輪廓已經實現(xiàn)了以后。

不必要的對象構造

不要在循環(huán)中構造和釋放對象

使用 StringBuffer 對象

在處理 String 的時候要盡量使用 StringBuffer 類，StringBuffer 類是構成 String 類的基礎。

String 類將 StringBuffer 類封裝了起來，（以花費更多時間為代價）為開發(fā)人員提供了一個安全的接口。當我們在構造字符串的時候，我們應該用 StringBuffer 來實現(xiàn)大部分的工作，當工作完成后將 StringBuffer 對象再轉換為需要的 String 對象。比如：如果有一個字符串必須不斷地在其后添加許多字符來完成構造，那么我們應該使用StringBuffer 對象和她的 append() 方法。如果我們用 String 對象代替StringBuffer 對象的話，會花費許多不必要的創(chuàng)建和釋放對象的 CPU 時間。大家可以來安安DIY創(chuàng)作室一起討論。

避免太多的使用 synchronized 關鍵字避免不必要的使用關鍵字 synchronized，應該在必要的時候再使用她，這是一個避免死鎖的好方法。

7、編程技巧

byte 數(shù)組轉換到 characters

為了將 byte 數(shù)組轉換到 characters，你可以這么做：

Hello world!.getBytes();

Utility 類

Utility 類（僅僅提供方法的類）應該被申明為抽象的來防止被繼承或被初始化。

初始化

下面的代碼是一種很好的初始化數(shù)組的方法：

objectArguments = new Object[] { arguments };

枚舉類型

JAVA 對枚舉的支持不好，但是下面的代碼是一種很有用的模板：

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);

}

這種技術實現(xiàn)了RED, GREEN, BLUE 等可以象其他語言的枚舉類型一樣使用的常量。

他們可以用 '==' 操作符來比較。

但是這樣使用有一個缺陷：如果一個用戶用這樣的方法來創(chuàng)建顏色 BLACK new Colour(0,0,0)

那么這就是另外一個對象，'=='操作符就會產生錯誤。她的 equal() 方法仍然有效。由于這個原因，這個技術的缺陷最好注明在文檔中，或者只在自己的包中使用。

8、編寫格式

代碼樣式

代碼應該用 unix 的格式，而不是 windows 的（比如：回車變成回車+換行）

文檔化

必須用 javadoc 來為類生成文檔。不僅因為它是標準，這也是被各種 java 編譯器都認可的方法。使用 @author 標記是不被推薦的，因為代碼不應該是被個人擁有的。

縮進

縮進應該是每行2個空格. 不要在源文件中保存Tab字符. 在使用不同的源代碼管理工具時Tab字符將因為用戶設置的不同而擴展為不同的寬度.如果你使用 UltrEdit 作為你的 Java 源代碼編輯器的話，你可以通過如下操作來禁止保存Tab字符, 方法是通過 UltrEdit中先設定 Tab 使用的長度室2個空格，然后用 Format|Tabs to Spaces 菜單將 Tab 轉換為空格。

頁寬

頁寬應該設置為80字符. 源代碼一般不會超過這個寬度, 并導致無法完整顯示, 但這一設置也可以靈活調整. 在任何情況下, 超長的語句應該在一個逗號或者一個操作符后折行. 一條語句折行后, 應該比原來的語句再縮進2個字符.

{} 對

{} 中的語句應該單獨作為一行. 例如, 下面的第1行是錯誤的, 第2行是正確的:

if (i0) { i ++ }; // 錯誤, { 和 } 在同一行

if (i0) {

i ++

}; // 正確, { 單獨作為一行

} 語句永遠單獨作為一行.如果 } 語句應該縮進到與其相對應的 { 那一行相對齊的位置。

括號

左括號和后一個字符之間不應該出現(xiàn)空格, 同樣, 右括號和前一個字符之間也不應該出現(xiàn)空格. 下面的例子說明括號和空格的錯誤及正確使用:

CallProc( AParameter ); // 錯誤

CallProc(AParameter); // 正確

不要在語句中使用無意義的括號. 括號只應該為達到某種目的而出現(xiàn)在源代碼中。下面的例子說明錯誤和正確的用法:

if ((I) = 42) { // 錯誤 - 括號毫無意義

if (I == 42) or (J == 42) then // 正確 - 的確需要括號

9、代碼編譯

1.編寫代碼時要注意隨時保存，并定期備份，防止由于斷電、硬盤損壞等原因造成代碼丟失。

2.同一項目組內，最好使用相同的編輯器，并使用相同的設置選項。

3.合理地設計軟件系統(tǒng)目錄，方便開發(fā)人員使用。

4.打開編譯器的所有告警開關對程序進行編譯。

5.在同一項目組或產品組中，要統(tǒng)一編譯開關選項。

6.使用工具軟件（如Visual SourceSafe）對代碼版本進行維護。如果大家有不明白的可以到安安DIY創(chuàng)作室留言。

10、可移植性

Borland Jbulider 不喜歡 synchronized 這個關鍵字，如果你的斷點設在這些關鍵字的作用域內的話，調試的時候你會發(fā)現(xiàn)的斷點會到處亂跳，讓你不知所措。除非必須，盡量不要使用。

換行

如果需要換行的話，盡量用 println 來代替在字符串中使用\n。

你不要這樣：

System.out.print(Hello,world!\n);

要這樣：

System.out.println(Hello,world!);

或者你構造一個帶換行符的字符串，至少要象這樣：

String newline = System.getProperty(line.separator);

System.out.println(Hello world + newline);

PrintStream

PrintStream 已經被不贊成（deprecated）使用，用 PrintWrite 來代替它。

java程序是由什么組成的

1.源程序文件的構成

要編寫Java程序，首先應該知道Java程序文件中必須包括什么內容，Java程序的源程序文件結構如下:

package語句，0～1句，必須放在文件開始，作用是把當前文件放入所指向的包中。import語句，0～多句，必須放在所有類定義之前，用來引入標準類或已有類。public?classDefinition，0～1句，文件名必須與類的類名完全相同。classDefinition，0～多句，類定義的個數(shù)不受限制。

interfaceDefinition，0～多句，接口定義的個數(shù)不受限制。Java程序的源代碼文件要求包含三個要素:

1）以package開始的包聲明語句，此句為可選。若有，且只能有一個package語句且只能是源程序文件的第一個語句，若沒有，此文件將放到默認的當前目錄下。

2）以import開始的類引入聲明語句，數(shù)量可以是任意個。

3）classDefinition和interfaceDefinition分別代表類和接口的定義。由public開始的類定義只能有一個，且要求源程序文件名必須和public類名相同，Java語言對字符的大小寫敏感，因此文件名相同意味著字母大小寫也完全相同。如果源程序文件中有主方法main（），它應放在public類中。????這三個要素在程序中必須嚴格按上述順序出現(xiàn)。

2.類的構成

Java程序都是由類（class）所組成的，類的概念的產生是為了讓程序語言能更清楚地表達出現(xiàn)實事物的本性。在Java中，類就是用于創(chuàng)建對象的模板，包含了特定對象集合的所有特性。Java類由兩種不同的信息構成:屬性和行為。

屬性由一系列區(qū)別對象的數(shù)據(jù)組成，可用于確定屬于類的對象的外觀、狀態(tài)和其他性質。在Java程序中，屬性往往以類的成員變量形式出現(xiàn)。

行為指類對象對本身和其他對象所可以完成的事情，可以用于修改對象的屬性，接收來自其他對象的信息和向其他要求執(zhí)行任務的對象發(fā)送信息。在Java中，行為往往以一段小程序的形式出現(xiàn)，Java稱這種小程序為“方法”（method）。統(tǒng)稱為類的成員方法。

Java中類定義的語法形式為:

修飾符?class?類名?［extend父類名］｛??type類變量1;type類變量2;

成員變量??修飾符?type類方法名1（參數(shù)列表）｛????type局

部變量;????方法體

｝修飾符?type類方法名2（參數(shù)列表）｛?????type局部變量;????方法體

｝??????成員方法｝

其中class是Java的關鍵字，表明其后定義的是一個類。class前面的修飾符用來限定所定義的類的使用方式。類名是用戶為該類起的名字，應該是一個合法的標識符。緊接著類定義語句的大括號之間的內容稱為類主體。type指的是變量或方法的數(shù)據(jù)類型。類主體由成員變量和成員方法兩部分組成。

以上所有提到或未提到的概念，在后面的章節(jié)中將詳細為大家介紹。

3.注釋語句的添加

在開發(fā)Java程序的過程中，經常需要在適當?shù)牡胤郊由献⑨屨Z句，以便其他人閱讀

程序，一般來說，Java語言的源文件中，任何地方都可以加注釋語句，一個好的程序應該在

其需要的地方適當?shù)丶由弦恍┳⑨?，以便于其他人閱讀并理解程序。

注釋語句有三種格式:

1）//注釋內容?????用于注釋一行語句。

2）/ˇ注釋內容ˇ/???用于注釋一行或多行語句。

3）/ˇˇ注釋內容ˇˇ/???用于注釋一行或多行語句且注釋語句中的內容可以通過使用Javadoc生成API文檔，實現(xiàn)文檔與程序同步實現(xiàn)的功能。

java源代碼的后綴名是什么

源代碼是.java

一般項目里邊可以很多類型的文件如：

.jsp

.jar等。

一個Java源程序一般是由哪三個基本部分組成的?

一個簡單的java程序由java包（如：import java.awt.*）、類聲明 、變量、構造方法（可缺?。?、方法 這幾部分構成。

java程序中至少要有一個類被聲明為public。

Java如何在數(shù)據(jù)組的頭部和尾部各添加一個元素

java ArrayList數(shù)組使用add來插入一個元素，實例如下：

import java.util.ArrayList;

public class Test {

public static void main(String[] args) {

ArrayList list = new ArrayList();

list.add(0);//插入第一個元素

list.add(1);

list.add(2);

list.add(3);

list.add(4);

list.add(5);

System.out.println(list);//打印list數(shù)組

list.add(2, 7);

System.out.println(list);

}

}

文章題目：Java源代碼的頭和尾,JAVA源代碼是什么
標題來源：http://m.jiaotiyi.com/article/dsgopcd.html