java開發(fā)軟件代碼 java代碼開發(fā)工具

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

1、組織與風格

站在用戶的角度思考問題,與客戶深入溝通,找到景谷網(wǎng)站設計與景谷網(wǎng)站推廣的解決方案,憑借多年的經(jīng)驗,讓設計與互聯(lián)網(wǎng)技術(shù)結(jié)合,創(chuàng)造個性化、用戶體驗好的作品,建站類型包括:成都網(wǎng)站設計、網(wǎng)站制作、企業(yè)官網(wǎng)、英文網(wǎng)站、手機端網(wǎng)站、網(wǎng)站推廣、域名與空間、虛擬空間、企業(yè)郵箱。業(yè)務覆蓋景谷地區(qū)。

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

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

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

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

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

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

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

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

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

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

2、注解

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

// 注釋一行

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

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

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

注釋要簡單明了。

String userName = null; //用戶名

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

在必要的地方注釋,注釋量要適中。注釋的內(nèi)容要清楚、明了,含義準確,防止注釋二義性。

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

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

同一結(jié)構(gòu)中不同域的注釋要對齊。

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

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

在每個源文件的頭部要有必要的注釋信息,包括:文件名;版本號;作者;生成日期;模塊功能描述(如功能、主要算法、內(nèi)部各部分之間的關(guān)系、該文件與其它文件關(guān)系等);主要函數(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ù)或過程名稱;功能描述;輸入、輸出及返回值說明;調(diào)用關(guān)系及被調(diào)用關(guān)系說明等

/**

* 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 對類、屬性、方法的說明 參考轉(zhuǎn)向,也就是相關(guān)主題

@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ī)則:

版權(quán)信息

版權(quán)信息必須在 java 文件的開頭,比如:

/*

* Copyright ? 2000 Shanghai XXX Co. Ltd.

* All right reserved.

*/

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

Package/Imports

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

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

package hotlava點虐 .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; }

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

構(gòu)造函數(shù)

接下來是構(gòu)造函數(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[]) 方法已經(jīng)定義了, 那么它應該寫在類的底部.

5、代碼可讀性

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

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

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

6、代碼性能

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

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

不必要的對象構(gòu)造

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

使用 StringBuffer 對象

在處理 String 的時候要盡量使用 StringBuffer 類,StringBuffer 類是構(gòu)成 String 類的基礎。

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

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

7、編程技巧

byte 數(shù)組轉(zhuǎn)換到 characters

為了將 byte 數(shù)組轉(zhuǎn)換到 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);

}

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

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

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

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

8、編寫格式

代碼樣式

代碼應該用 unix 的格式,而不是 windows 的(比如:回車變成回車+換行)

文檔化

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

縮進

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

頁寬

頁寬應該設置為80字符. 源代碼一般不會超過這個寬度, 并導致無法完整顯示, 但這一設置也可以靈活調(diào)整. 在任何情況下, 超長的語句應該在一個逗號或者一個操作符后折行. 一條語句折行后, 應該比原來的語句再縮進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.同一項目組內(nèi),最好使用相同的編輯器,并使用相同的設置選項。

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

4.打開編譯器的所有告警開關(guān)對程序進行編譯。

5.在同一項目組或產(chǎn)品組中,要統(tǒng)一編譯開關(guān)選項。

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

10、可移植性

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

換行

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

你不要這樣:

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

要這樣:

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

或者你構(gòu)造一個帶換行符的字符串,至少要象這樣:

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

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

PrintStream

PrintStream 已經(jīng)被不贊成(deprecated)使用,用 PrintWrite 來代替它。

怎樣把一個java源代碼做成一個軟件成品?

1.其實就是用一個外部程序 調(diào)用java虛擬機運行你的java程序。

2.可以做一個批處理文件,在里面調(diào)用java 虛擬機運行你的java程序。

3.也可以用某種編程語言,像vb ,c 或c++編個程序,生成exe,能調(diào)用java虛擬機運行你的程序,很簡單的。

【源代碼】

源代碼(也稱源程序),是指一系列人類可讀的計算機語言指令。 在現(xiàn)代程序語言中,源代碼可以是以書籍或者磁帶的形式出現(xiàn),但最為常用的格式是文本文件,這種典型格式的目的是為了編譯出計算機程序。

延展閱讀;

Java是一門面向?qū)ο缶幊陶Z言,不僅吸收了C++語言的各種優(yōu)點,還摒棄了C++里難以理解的多繼承、指針等概念,因此Java語言具有功能強大和簡單易用兩個特征。Java語言作為靜態(tài)面向?qū)ο缶幊陶Z言的代表,極好地實現(xiàn)了面向?qū)ο罄碚?,允許程序員以優(yōu)雅的思維方式進行復雜的編程。

做java軟件工程師,怎樣才能寫出好的代碼?

Java代碼之于java程序員而言就是左膀右臂,java代碼寫的好的java程序員明顯更是企業(yè)的歡迎,一個優(yōu)秀的java程序員的考核標準之一也是看他的編程水平。

其實有的java程序員java代碼會受到大家的追捧,是因為他在寫代碼時注意的細節(jié)往往多于那些不怎么關(guān)注java代碼編程細節(jié)的程序員,俗話說:“細節(jié)決定成敗”,那么如何寫出好的java代碼呢?IT培訓介紹一起來討論下:

1.重視注釋

有的java程序員在寫代碼時,從來沒有想過要在java代碼后加上相關(guān)的注釋,甚至是上萬行的代碼也沒有想過加上注釋,這就存在很大的問題,不說你的代碼會跟其他人分享討論,就你自己回顧你是怎么寫好這篇代碼的,你也是半天無法理出頭緒,這就為維護和修改等等工作添加了很大的麻煩。所以,要想寫出好的java代碼,一定從簡短的java代碼編寫開始注重在java代碼后面加上相應的注釋,養(yǎng)成良好的習慣。

2.重視排版整潔

看很多java程序員的排版總覺得在欣賞一幅藝術(shù)品,但是看到一些java程序員的排版卻總覺得無力吐槽。同樣是編寫代碼,但是給人的視覺體驗是相當?shù)牟煌斎缓玫膉ava代碼給人的享受也是美的,所以要想寫出好的代碼,一定要重視排版整潔。

3.注重命名規(guī)則

現(xiàn)在在一個團隊開發(fā)中,都會提前定制一個統(tǒng)一的命名規(guī)則,這樣利于提高工作效益。但是很多java程序員是缺乏這個意識的,每次敲代碼,更喜歡按照自己慣常的方式老命名模塊、函數(shù),這樣是方便了自己,但是忽視團隊協(xié)作,所以在日常工作中,特別是團隊工作中一定要重視命名規(guī)則。

4.養(yǎng)成備份習慣

備份的重要性不用小編強調(diào),相必你也知道。但是有的java程序員就是沒有養(yǎng)成這樣的好習慣,每次敲完代碼就不記得隨手保存,每次等到除了事故,比如電腦出了故障,辛辛苦苦敲打的java代碼沒保存找不回來的情況下就開始懊惱,與其這樣還不如在一開始就養(yǎng)成良好的備份習慣,這樣也方便自己日后查找利用。

java用什么軟件編寫

JAVA編程常用的軟件:

1、Intellij IDEA

Intellij IDEA是當前Java開發(fā)人員呼聲很高的一款IDE,具有美觀,高效等眾多特點,小編還是非常喜歡的,所以以往我都是在自己電腦安裝這款軟件的。

2、Eclipse

Eclipse是免費的,這點很重要,所以大多公司里依然是使用eclipse這款IDE,而且它良好的性能,也在市場占著不小的比重。

3、MyEclipse

MyEclipse是同eclipse一個公司的,在功能上增加了不少,相對于eclipse來說,myeclipse更像將eclipse中好多插件都集成起來了,當然,性能上面也有更好的考慮,不過這款IDE是收費的。

4、NetBeans

NetBeans是甲骨文公司生產(chǎn)的IDE,在其中也內(nèi)置了許多功能,相對于idea和eclipse市場還是較少的。

5、JDK

JDK是Java語言必備的工具,我們代碼編寫、編譯、運行都是依靠jdk來幫助我們運作,jdk是編寫Java代碼的根基。

網(wǎng)站欄目:java開發(fā)軟件代碼 java代碼開發(fā)工具
URL網(wǎng)址:http://muchs.cn/article12/ddiejdc.html

成都網(wǎng)站建設公司_創(chuàng)新互聯(lián),為您提供App設計、企業(yè)建站企業(yè)網(wǎng)站制作、外貿(mào)建站、品牌網(wǎng)站建設、網(wǎng)站改版

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)

成都app開發(fā)公司