您现在的位置：考试吧(Exam8.com) > 软件水平考试 > 心得技巧 > 正文

JAVA的编程风格

来源：ChinaUnix　2005年3月24日　【考试吧：中国教育培训第一门户】　模拟考场　视频课程

     什么应当使用JavaDoc做注释？如何注释的恰当呢？

    可以这样想，JavaDoc中所作的注释都可以在类的文档中看到。所有读这个类的文档的读者都会明白这个类所完成的功能、它包括的方法、如何使用这些方法及方法的返回值。一些作用域，比如public的变量或常量将会一目了然。任何不了解这个类内部结构的人都可以轻松的调用它。这便是你用JavaDoc可以轻松提供的信息。而使用一般注释的地方，一般是给那些可能修改你的类代码的程序员，它们一般描述了类的内部信息和结构。

    下面我写一下car的类来描述一个编程风格好的java类应该是怎样的。当然这仅仅是一个小例子(apart from selector and mutator methods)，仅仅是在考虑JAVA编程风格上一个参考而已。

代码:

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

上一页 1 2 3

转帖于：软件水平考试_考试吧

交流：考试吧软件水平考试论坛　模考：在线考试中心

推荐给朋友

收藏此页

打印此页

看了本文的网友还看了：

·软考高分通关心得分享：10年编程无师自通  (2008-10-28 15:55:29)
·软考经验分享：2008年网页设计十条经验总结  (2008-10-28 15:33:37)
·不为系分而系分谈如何过系分及考过后的思考  (2007-11-27 15:59:28)
·《系统分析师教程》主编侯炳辉谈如何进阶系分  (2007-11-14 9:26:46)
·我对2007下半年软考网工题目的一点分析  (2007-11-10 10:43:45)
·软考经验谈：软考考前战略---深挖洞广积粮  (2007-5-22 18:07:13)

·系统安全软件水平考试网校公告软考英语复习资料软考网络工程师模拟试题信息系统管理工程师复习资料

软件水平考试权威辅导教材：　订书电话：010-62168566　　更多>>>

网友评论

版权声明 --------------------------------------------------------------------------------------
如果软件水平考试网所转载内容不慎侵犯了您的权益，请与我们联系

，我们将会及时处理。如转载本软件水平考试网内容，请注明出处。

首页　考试吧论坛　 Exam8视线　考试商城　网络课程　面授课程　模拟考试　实用文档　缤纷校园　英语学习
		2010考研 \| 自学考试 \| 成人高考 \| 专升本 \| 法律硕士 \| MBA/MPA \| 中科院
		四六级 \| 商务英语 \| 公共英语 \| 职称日语 \| 职称英语 \| 博思 \| 口译笔译 \| GRE GMAT \| 日语 \| 托福
		雅思 \| 专四专八 \| 新概念 \| 自考英语 \| 零起点英、法、德、日、韩语 \| 在职申硕英语
		在职攻硕英语 \| 成人英语三级
		等级考试 \| 水平考试 \| 微软认证 \| 思科认证 \| Oracle认证 \| Linux认证
		公务员 \| 报关员 \| 报检员 \| 外销员 \| 司法考试 \| 导游考试 \| 教师资格 \| 国际商务师 \| 跟单员
		单证员 \| 物流师 \| 价格鉴证师 \| 银行从业资格 \| 证券从业资格 \| 人力资源管理师 \| 管理咨询师
		期货从业资格 \| 社会工作者
		会计职称 \| 注会CPA \| 经济师 \| 统计师 \| 注册税务师 \| 评估师 \| 精算师 \| 高会 \| ACCA \| 审计师
		法律顾问 \| 会计证
		建造师（一级、二级） \| 造价师 \| 监理师 \| 安全师 \| 咨询师 \| 结构师 \| 建筑师 \| 安全评价师
		估价师（房地产估价、土地估价） \| 设备监理师 \| 岩土工程师 \| 质量资格 \| 房地产经纪人 \| 造价员
		投资项目管理 \| 土地代理人 \| 环保师 \| 环境影响评价 \| 物业管理师 \| 城市规划师 \| 公路监理师
		公路造价工程师 \| 招标师
		执业护士 \| 执业医师 \| 执业药师 \| 卫生资格