Java 文档注释、类型转换、包装类

　　

文档注释

文档注释主要用于生成API文档，而API文档主要用于说明类、成员变量、方法的功能，所以文档注释只放在类、内部类、接口、成员变量、方法之前，且javadoc只处理这些地方的文档注释，而忽略其它地方的文档注释。

API文档相当于产品说明书，而说明书只需要介绍那些暴露的、供用户使用的部分，所以javadoc默认只提取public、protected修饰的部分。如果要提取private修饰的部分，需用 -private 指定。

形式：
/**
文档注释
*/

文档注释可以自己随意写，也可以使用javadoc标记。

常用的javadoc标记：
@author 指定作者(开发者)
@version 指定源文件版本
@deprecated 不推荐使用的方法
@param 方法的参数的说明信息
@return 方法的返回值的说明信息
@see "参见"，指定交叉参考的内容
@exception 抛出的异常类型
@throws 同上

javadoc标记的使用位置是有限制的：
类、接口之前可用@see、@deprecated、@author、@version；
方法之前可用@see、@deprecated、@param、@return、@throws、@exception；

示例：

package my_package;

/**
 * Description:
 * 网站：<a href="www.jollyaini.com">jolly爱你天才</a><br>
 * Copyright (C)，2010-2019，chenhongyong<br>
 * This program id protected by copyright laws.<br>
 * Program Name:001 文档注释<br>
 * Date:2019-05-01<br>
 * @author chenhongyong 3213973159@qq.com<br>
 * @version 1.0
 */
public class Name {
    private String name;

    /**
     * 构造函数，初始化name
     * @param  name 要初始化的name的值
     */
    public Name(String name){
        this.name=name;
    }

    /**
     * 获取name的值
     * @return 返回name的值
     */
    public String getName(){
        return this.name;
    }

    /**
     * 设置name的值
     * @param name 要设置的name的值
     */
    public void setName(String name){
        this.name=name;
    }



}
 

 使用IDEA生成API文档：

Tools -> Generate JavaDoc -> 勾选所需选项、设置输出目录、设置参数

Locale:zh_CN     指定国家、语言代码，这个参数可缺省

Other command line arguments：-encoding UTF-8 -charset UTF-8     设置命令行参数 

第一个参数表示源文件编码格式为utf-8

第二个参数指定生成的API文档的编码格式为utf-8

主要是为了防止中文乱码

点击ok即可。生成的API文档的入口文件为index.html。

---

类型转换

package my_package;

import java.util.Arrays;

/**
 * 基础数据类型的一些操作
 * 基础数据类型本身就是一个类，自带了很多静态方法，可直接使用
 * String的实例也可以使用String类的很多方法
 */
public class Test {
    public static void main(String[] args) {
        //整除，两个操作数都为整数时，结果只保留整数部分
        System.out.println(3/2);

       //强制类型转换
        int a=(int)1.5;
        System.out.println(a);

        //使用String.valueOf()可以把其它类型的值转换为String型，适用于数值型、char、char[]、boolean、Object
        String str1=String.valueOf(1.5);
        System.out.println(str1);

        //String的实例也可以使用很多方法
        System.out.println("hello".endsWith("lo"));

        //除了String，每个基础类型都提供了静态方法parseXxx(String str)将String转换为自身的类型
        System.out.println(Integer.parseInt("1"));

        //除了String，每个基础类型都提供了静态方法toString(Xxx x)将本身类型的值转换为String类型
        String str2=Integer.toString(2);
        System.out.println(str2);

    }
}

---

包装类

8种基本数据类型的包装类：

byte　　 Byte
short 　　 Short
int 　　 Integer
long　　 Long
char　　 Character
float　　 Float
double 　　 Double
boolean　　 Boolean

注意没有String

包装类的对象是引用型的。

 所有数值型的包装类都是Number类的子类，Number类是一个抽象类。

将字符串转换为基础数据类型的两种方法：
包装类.parseXxx(String str) //Character除外，无此种方法
包装类.valueOf(String str)
注意字符串转基础数据类型，不能用 (基础数据类型)字符串 的方式。

String提供了多个重载的static的valueOf()，可以将基础数据类型转换为String
String.valueOf(基础数据类型值)