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

男娘i 2023-03-13 03:18 0阅读 0赞

### 目录 ###

*   *   *  常用命令
         *  注释
         *  生成API文档
         *  命令行参数

### 常用命令 ###

#编译，.class文件默认与源文件存放在同一目录下
    javac Xxx.java
    
    #解析.class文件，查看编译器编译、优化后得到的汇编指令、本地变量表、常量池等信息
    #不能像linux一样合并写成-clp
    javap -c -l -p Xxx.class

### 注释 ###

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

类、接口上常用的标注

/** * 操作数据库的工具类 #对类|接口进行说明，可以使用html标签，但使用单标签时不能自己关闭，比如<br />只能写成<br> * @author chy xxxxx@qq.com #此部分代码开发者的信息、联系方式 * @version 1.0 #版本 * @deprecated #不推荐使用 * @see conf.DbConfig #另请参阅，链接到其它类|接口的文档 */
    public class DbUtil { 
       
    }

方法上常用的标注

/** * 根据用户id查询对应的用户名 #对方法整体的说明，一般是方法功能 * @deprecated #不推荐使用 * @param username 用户名 #参数含义 * @param password 密码 * @return 受影响的记录数。插入成功返回1，插入失败返回0 * @throws IOException #抛出的异常 * @exception IOException #也可以用此标记来说明抛出的异常 * @see conf.DbConfig #另请参阅 */
    public Integer addUsernameById(String username,String password) throws IOException{ 
    
    }

### 生成API文档 ###

使用IDEA提取API文档

Tools -> Generate JavaDoc -> 勾选所需选项，设置输出目录、参数  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70]  
Locale：zh\_CN  
指定API文档的语言代码，缺省时默认为操作系统使用的语言，大陆是简体中文

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

IDEA提取实际是调用javadoc命令

### 命令行参数 ###

*  IDEA debug | run  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70 1]
 *  命令行运行jar包

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

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70]: /images/20230312/09d3497280624e0db9848ad707e1cc24.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoeV8xODg4MzcwMTE2MQ_size_16_color_FFFFFF_t_70 1]: /images/20230312/bbe78ee5a3364ba2b9cc0dcac23089e9.png