包机制、JavaDoc
包的本质就是文件夹
一般利用公司域名倒置作为包名;com.xxxxxx.blog
package xxxxxx必须放在最上面
文档注释
参数信息
-
@auther 作者名
-
@version 版本号
-
@since 知名需要最早使用的jdk版本
-
@param 参数名
-
@return 返回值情况
-
@throws 异常抛出情况
package base; /* @auther wangdong @version 1.0 @since 1.8 */ public class Doc { String name; /** * @auther wangdong * @param name * @return */ public String test(String name){ return name; } }
javadoc -encoding UTF-8 -charset UTF-8 Doc.java //生成java文档
//通过命令行 //学会查找使用IDEA生产JavaDoc文档! 面向百度变成
(以下是网上抄的)
在IDEA中选择工具(Tool)选项卡打开
选择生成JavaDoc
第一步:选择生成JavaDoc文档的范围,我只对一个源文件生成Doc,所以选择文件。
第二步:输出目录最好新建一个文件夹,比较有条理和整洁
第三步:区域设置,决定文档的语言,简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
第四步:其他命令行参数:如果区域设置为中国,参数一般为-encoding UTF-8 -charset UTF-8
第五步:设置完成后点击确定即可生成Doc文档 查看JavaDoc文档
index.html