java学习笔记(二)
2016-02-01 10:12
417 查看
J***A学习笔记(二)
记录J***A中注释的用法。一般注释
J***A中的单行注释用”//”,如:[code]String warnStr = "Wrong!" //警告字符串
J***A中的块注释用
/* */,如:
[code]/*这 是 一 个 多 行 注 释*/ int test = 0;
javadoc实用工具
javadoc会从包,公有类与接口,公有的和受保护的构造器及方法,公有的和受保护的域中提取特性信息,生成html文件。在这些抽取特性信息的地方应该编写注释,注释以
/**开头,
*/结尾。
在注释中首先用自由文本格式写上描述性的文字,而后可以用各种标签来实现特性,此外,在这注释中支持html标签,不过不要使用
<h1>之类的排版标签,否则会导致排版错误。
可以用的标签有很多,具体不细表,一般IDE中会自动提供一些,其他的可以自己去了解。
示例如下:
[code]package xyz.zhanymx; /** * <code>People</code>类包含人的姓名,性别与年龄三个属性,可以作为一般的职务类的超类. * Created by kevin on 16/2/1. * @author kevin * @version 1.0 */ public class People { private String name; private String sex; private int age; /** * 无参构造器,用来对参数初始化. */ public People(){ name = ""; sex = "m"; age = 0; } /** * 一般构造器,构造指定的<code>People</code>对象. * @param name 姓名 * @param sex 性别;性别用m和f表示 * @param age 年龄 */ public People(String name,String sex,int age){ this(); this.name = name; setSex(sex); this.age = age; } /** * 获取姓名 * @return 返回String类型的姓名 */ public String getName(){ return name; } /** * 获取性别 * @return 返回String类型的性别 */ public String getSex(){ return sex; } /** * 获取年龄 * @return 返回int类型的年龄 */ public int getAge(){ return age; } /** * 设置姓名 * @param name 姓名参数 */ public void setName(String name){ this.name = name; } /** * 设置性别 * @param sex 对性别的格式进行判断,如果不符合格式则给出警告 */ public void setSex(String sex){ if ((!sex.equals("m"))&&(!sex.equals("f"))){ System.out.println("请输入m或f代表男女"); return; } this.sex = sex; return; } /** * 设置年龄 * @param age 年龄参数 */ public void setAge(int age){ this.age = age; } }
生成javadoc文档形式如下:
相关文章推荐
- Java多线程入门
- JAVA List容器内部差异化比较工具类(咋个办呢 zgbn)
- Eclipse导入项目
- 【java】学习笔记(一)
- 2016蓝桥杯假期任务之《奇怪的比赛》
- 饿汉式单例与懒汉式单例的讨论
- Struts2 语法--result type
- java获取大文件的MD5、SHA1,CRC32码
- IoDH 实现的单例模式
- Java 解析 XML
- SpringMVC之controller篇
- Failed to load JavaHL Library解决方法
- Spring4.x+hibernate5.x的整合之基础操作的封装(CRUD包含分页)(待补充)
- Java 传递参数
- 讲解Java设计模式编程中的建造者模式与原型模式
- Struts2的那些小细节
- 基于Eclipse的Android开发环境搭建及初步使用教程
- eclipse中格式化代码快捷键Ctrl+Shift+F失效的解决办法
- Java - 构造函数、this 和 super的使用
- [java]_[Collections.sort()实现List排序]