學(xué)歷| 高考 考研 自考 成考 外語| 四六級 商務(wù)英語 公共英語 職稱英語 資格| 公務(wù)員 報關(guān)員 報檢員 司法 導(dǎo)游 銀行從業(yè) 計(jì)算機(jī)| 等考 軟考
工程| 建造師 造價師 監(jiān)理師 安全師 咨詢師 結(jié)構(gòu)師 估價師 會計(jì)| 會計(jì)職稱 注會CPA 經(jīng)濟(jì)師 稅務(wù)師 評估師 醫(yī)學(xué)| 衛(wèi)生資格 醫(yī)師 藥師 [更多]
首頁 考試吧論壇 Exam8視線 考試商城 網(wǎng)絡(luò)課程 面授課程 模擬考試 實(shí)用文檔 繽紛校園 英語學(xué)習(xí) | ||
2010考研 | 自學(xué)考試 | 成人高考 | 專 升 本 | 法律碩士 | MBA/MPA | 中 科 院 | ||
四六級 | 商務(wù)英語 | 公共英語 | 職稱日語 | 職稱英語 | 博思 | 口譯筆譯 | GRE GMAT | 日語 | 托福 | ||
雅思 | 專四專八 | 新概念 | 自考英語 | 零起點(diǎn)英、法、德、日、韓語 | 在職申碩英語 | ||
在職攻碩英語 | 成人英語三級 | ||
等級考試 | 水平考試 | 微軟認(rèn)證 | 思科認(rèn)證 | Oracle認(rèn)證 | Linux認(rèn)證 | ||
公務(wù)員 | 報關(guān)員 | 報檢員 | 外銷員 | 司法考試 | 導(dǎo)游考試 | 教師資格 | 國際商務(wù)師 | 跟單員 | ||
單證員 | 物流師 | 價格鑒證師 | 銀行從業(yè)資格 | 證券從業(yè)資格 | 人力資源管理師 | 管理咨詢師 | ||
期貨從業(yè)資格 | 社會工作者 | ||
會計(jì)職稱 | 注會CPA | 經(jīng)濟(jì)師 | 統(tǒng)計(jì)師 | 注冊稅務(wù)師 | 評估師 | 精算師 | 高會 | ACCA | 審計(jì)師 | ||
法律顧問 | 會計(jì)證 | ||
建造師(一級、二級) | 造價師 | 監(jiān)理師 | 安全師 | 咨詢師 | 結(jié)構(gòu)師 | 建筑師 | 安全評價師 | ||
估價師(房地產(chǎn)估價、土地估價) | 設(shè)備監(jiān)理師 | 巖土工程師 | 質(zhì)量資格 | 房地產(chǎn)經(jīng)紀(jì)人 | 造價員 | ||
投資項(xiàng)目管理 | 土地代理人 | 環(huán)保師 | 環(huán)境影響評價 | 物業(yè)管理師 | 城市規(guī)劃師 | 公路監(jiān)理師 | ||
公路造價工程師 | 招標(biāo)師 | ||
執(zhí)業(yè)護(hù)士 | 執(zhí)業(yè)醫(yī)師 | 執(zhí)業(yè)藥師 | 衛(wèi)生資格 |
什么應(yīng)當(dāng)使用JavaDoc做注釋?如何注釋的恰當(dāng)呢?
可以這樣想,JavaDoc中所作的注釋都可以在類的文檔中看到。所有讀這個類的文檔的讀者都會明白這個類所完成的功能、它包括的方法、如何使用這些方法及方法的返回值。一些作用域,比如public的變量或常量將會一目了然。任何不了解這個類內(nèi)部結(jié)構(gòu)的人都可以輕松的調(diào)用它。這便是你用JavaDoc可以輕松提供的信息。而使用一般注釋的地方,一般是給那些可能修改你的類代碼的程序員,它們一般描述了類的內(nèi)部信息和結(jié)構(gòu)。
下面我寫一下car的類來描述一個編程風(fēng)格好的java類應(yīng)該是怎樣的。當(dāng)然這僅僅是一個小例子(apart from selector and mutator methods),僅僅是在考慮JAVA編程風(fēng)格上一個參考而已。
代碼: |
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; } } |