JAVA学习笔记（二）

记录JAVA中注释的用法。

---

一般注释

JAVA中的单行注释用”//”，如：

String warnStr = "Wrong!" //警告字符串

JAVA中的块注释用/* */,如：

/*这是一个多行注释*/  int test = 0;

javadoc实用工具

javadoc会从包，公有类与接口，公有的和受保护的构造器及方法，公有的和受保护的域中提取特性信息，生成html文件。
在这些抽取特性信息的地方应该编写注释，注释以/**开头，*/结尾。
在注释中首先用自由文本格式写上描述性的文字，而后可以用各种标签来实现特性，此外，在这注释中支持html标签，不过不要使用<h1>之类的排版标签，否则会导致排版错误。
可以用的标签有很多，具体不细表，一般IDE中会自动提供一些，其他的可以自己去了解。
示例如下：

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文档形式如下：