为了更好的组织类
!!!一般利用公司域名倒置作为包名
比如 com.cp_echo.blog;
导包import 写在package下面
import java.util.Date;
// 包语法结构
package pkg1.pkg2.pkg3;
// 导包语法结构
import pkg1.pkg2.pkg3;
注:阿里巴巴开发手册
Javadoc命令是用来生成自己API文档的
参数信息
加在类上面就是类的注释,加在方法上面就是方法的注释
package com.cp.echo;
/**
* @author cp
* @version 1.0
* @since 1.8
*/
public class Doc {
String name;
// /** enter 自动生成
/**
*
* @param name
* @return
* @throws Exception
*/
public String test(String name) throws Exception{
return name;
}
}
生成以上Javadoc文档,cd到当前目录,可以用浏览器打开,地址前面加cmd
输入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java
前面加上-encoding UFT-8 -charset UTF-8 参数,防止中文乱码。
生成Javadoc文档有两种方法:
①,上面的方法,通过命令行, javadoc 参数 java文件
②,使用IDEA生成Javadoc文档
https://blog.csdn.net/weixin_42140580/article/details/89635775
原文:https://www.cnblogs.com/chen-echo/p/14990912.html