首頁(yè) 考試吧論壇 Exam8視線 考試商城 網(wǎng)絡(luò)課程 面授課程 模擬考試 實(shí)用文檔 繽紛校園 英語(yǔ)學(xué)習(xí)
2010考研 | 自學(xué)考試 | 成人高考 | 專 升 本 | 法律碩士 | MBA/MPA | 中 科 院
四六級(jí) | 商務(wù)英語(yǔ) | 公共英語(yǔ) | 職稱日語(yǔ) | 職稱英語(yǔ) | 博思 | 口譯筆譯 | GRE GMAT | 日語(yǔ) | 托福
雅思 | 專四專八 | 新概念 | 自考英語(yǔ) | 零起點(diǎn)英、、韓語(yǔ) | 在職申碩英語(yǔ)
在職攻碩英語(yǔ) | 成人英語(yǔ)三級(jí)
等級(jí)考試 | 水平考試 | 微軟認(rèn)證 | 思科認(rèn)證 | Oracle認(rèn)證 | Linux認(rèn)證
公務(wù)員 | 報(bào)關(guān)員 | 報(bào)檢員 | 外銷員 | 司法考試 | 導(dǎo)游考試 | 教師資格 | 國(guó)際商務(wù)師 | 跟單員
單證員 | 物流師 | 價(jià)格鑒證師 | 銀行從業(yè)資格 | 證券從業(yè)資格 | 人力資源管理師 | 管理咨詢師
期貨從業(yè)資格 | 社會(huì)工作者
會(huì)計(jì)職稱 | 注會(huì)CPA | 經(jīng)濟(jì)師 | 統(tǒng)計(jì)師 | 注冊(cè)稅務(wù)師 | 評(píng)估師 | 精算師 | 高會(huì) | ACCA | 審計(jì)師
法律顧問 | 會(huì)計(jì)證
建造師一級(jí)、二級(jí)) | 造價(jià)師 | 監(jiān)理師 | 安全師 | 咨詢師 | 結(jié)構(gòu)師 | 建筑師 | 安全評(píng)價(jià)師
估價(jià)師房地產(chǎn)估價(jià)土地估價(jià)) | 設(shè)備監(jiān)理師 | 巖土工程師 | 質(zhì)量資格 | 房地產(chǎn)經(jīng)紀(jì)人 | 造價(jià)員
投資項(xiàng)目管理 | 土地代理人 | 環(huán)保師 | 環(huán)境影響評(píng)價(jià) | 物業(yè)管理師 | 城市規(guī)劃師 | 公路監(jiān)理師
公路造價(jià)工程師 | 招標(biāo)師
執(zhí)業(yè)護(hù)士 | 執(zhí)業(yè)醫(yī)師 | 執(zhí)業(yè)藥師 | 衛(wèi)生資格
 丹丹云 
您現(xiàn)在的位置: 考試吧(Exam8.com) > 軟件水平考試 > 心得技巧 > 正文

JAVA的編程風(fēng)格



     什么應(yīng)當(dāng)使用JavaDoc做注釋?如何注釋的恰當(dāng)呢?

    可以這樣想,JavaDoc中所作的注釋都可以在類的文檔中看到。所有讀這個(gè)類的文檔的讀者都會(huì)明白這個(gè)類所完成的功能、它包括的方法、如何使用這些方法及方法的返回值。一些作用域,比如public的變量或常量將會(huì)一目了然。任何不了解這個(gè)類內(nèi)部結(jié)構(gòu)的人都可以輕松的調(diào)用它。這便是你用JavaDoc可以輕松提供的信息。而使用一般注釋的地方,一般是給那些可能修改你的類代碼的程序員,它們一般描述了類的內(nèi)部信息和結(jié)構(gòu)。

    下面我寫一下car的類來(lái)描述一個(gè)編程風(fēng)格好的java類應(yīng)該是怎樣的。當(dāng)然這僅僅是一個(gè)小例子(apart from selector and mutator methods),僅僅是在考慮JAVA編程風(fēng)格上一個(gè)參考而已。

代碼:

import java.awt.Color;

/**
* This is a class representing cars. A car has certain features, such
* as color, age, number of doors etc and a car can be repainted,
* the tank can be filled etc.
*
* @author Jerry Meng
* @version %I%, %G%
*/
public class Car {

 /**
  * The maximum size of the tank in litres.
  */
 private static final double TANK_SIZE = 100.0;
 
 /**
  * The color of the car.
  */
 private Color color;    

 /**
  * The age of the car.
  */
 private int age;              
 
 /**
  * The number of doors of the car.
  */
 private int doors;              

 /**
  * The amount of gasoline in the tank.
  */
 private double gasoline;  

 /**
  * Class constructor, which constructs a brand new, black car with
  * five doors and a full tank.
  */
 public Car() {
   this(Color.black, 0, 5, TANK_SIZE);
 }
 
 /**
  * Class constructor specifying the color, age, number of doors
  * and litres of gasoline
  *
  * @param color    The color of the car
  * @param age      The age of the car
  * @param doors    The number of doors
  * @param km       Kilometres driven
  * @param gasoline The litres of gasoline
  */
 public Car(Color color, int age, int doors, double gasoline) {
   this.color = color;
   this.age = age;
   this.doors = doors;
   this.gasoline = gasoline;
 }
 
 /**
  * Returns the color of the car
  */
 public Color getColor() {
   return color;
 }

 /**
  * Repaints the car (i.e. changes its color)
  */
 public void setColor(Color color) {
   this.color = color;
 }
 
 /**
  * Returns the age of the car
  */
 public int getAge() {
   return age;
 }

 /**
  * Returns the number of doors of the car
  */
 public int getDoors() {
   return doors;
 }

 /**
  * Returns the amount of gasoline in the tank
  */
 public double getGasoline() {
   return gasoline;
 }

 /**
  * Fills the tank. The amount of gasoline cannot exceed
  * the size of the tank. In that case, the tank will be
  * filled to the maximum and the rest will run out in
  * the sand.
  *
  * @param gas  The amount of gasoline to put in the tank
  */
 public void setGasoline(double gas) {
   
   if(gasoline + gas <= TANK_SIZE)
     gasoline+=gas;
   else
     gasoline = TANK_SIZE;  
 }
}

上一頁(yè)  1 2 3 
轉(zhuǎn)帖于:軟件水平考試_考試吧
文章搜索
JAVA的編程風(fēng)格網(wǎng)友評(píng)論網(wǎng)友評(píng)論
版權(quán)聲明 --------------------------------------------------------------------------------------
    如果軟件水平考試網(wǎng)所轉(zhuǎn)載內(nèi)容不慎侵犯了您的權(quán)益,請(qǐng)與我們聯(lián)系,我們將會(huì)及時(shí)處理。如轉(zhuǎn)載本軟件水平考試網(wǎng)內(nèi)容,請(qǐng)注明出處。