Java 常用命令、文档注释、命令行参数

 

注释

//单行注释


/*
 * 多
 * 行
 * 注
 * 释
 */


/**
 * 文档注释
 * 一般标注在类、接口、对外暴露的成员上，描述功能、使用说明
 */

 

/**
 * 订单业务服务
 *
 * @author chy xxx@xxx.com
 * @version 1.0
 * @since 2020/01/01
 * @deprecated 已废弃，请使用xxx代替
 */
public class OrderRespBo {

}

• @author 指定作者信息、联系方式
• @since 常用于指定创建时间、起始版本

 

/**
 * 获取展示文案
 *
 * @param userId   用户id
 * @param vipLevel vip等级
 * @return String 展示文案
 * @throws IOException           IO异常
 * @exception NumberFormatException 数字格式异常
 */
public String getText(Long userId, Integer vipLevel) throws IOException, NumberFormatException {
    return null;
}

@throws、@exception 等效，更推荐使用 @throws

 

/**
 * 订单状态
 *
 * @see OrderStatusEnum
 * @see OrderStatusEnum#statusCode
 * @see OrderStatusEnum#getEnumByStatusCode
 * @see OrderStatusEnum#getEnumByStatusCode(Integer)
 * @see #id
 * @see #getOrderStatusEnum
 */
private Integer orderStatus;


/**
 * 订单状态
 * <ul>
 *     <li>0 待付款</li>
 *     <li>1 已付款</li>
 *     <li>2 已发货</li>
 *     <li>3 已送达</li>
 *     <li>4 已签收</li>
 * </ul>
 * 可参考：{@link OrderStatusEnum} <br/>
 * 对接文档可参考：<a href="https://www.baidu.com">baidu</a>
 */
private Integer orderStatus;

@see、@link 都可以链接到某个类、某个类的字段方法，链接到当前类中的字段、方法时可以省略类名。二者区别在于 @see 独立成行、首尾不能有其它文本，@link 要放在 { } 中、前后可以有其它文本。

文档注释中可以直接写 html 标签。

 

常用命令

#编译，.class文件默认与源文件存放在同一目录下
javac Xxx.java

#解析.class文件，查看编译器编译、优化后得到的汇编指令、本地变量表、常量池等信息
#不能像linux一样合并写成-clp
javap -c -l -p Xxx.class

 

生成API文档

使用IDEA提取API文档

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

Locale：zh_CN
指定API文档的语言代码，缺省时默认为操作系统使用的语言，大陆是简体中文

Other command line arguments：-encoding UTF-8 -charset UTF-8
设置命令行参数，第一个表示源文件编码字符集是utf-8，第二个指定要生成的API文档的编码字符集是utf-8

IDEA提取实际是调用javadoc命令

 

命令行参数

• IDEA debug | run
  

• 命令行运行jar包

#会以字符串数组的形式传入，字符串不需要加双引
java -jar xxx.jar 参数1 参数2 参数3