java学习笔记四:javaDoc

javaDoc是一种文档注释,文档注释就是在开始的 /** +回车之后,第一行或几行是关于类、变量和方法的主要描述,在类上面的是类的描述,在方法上面的是方法的描述

通过命令行生成javaDOC文档

package operator;

/**
 * @author zhulang
 * @version 1.0
 * @since 1.0
 */

public class Doc {
    String name;

    /**
     * @param name
     * @return
     */
    public String test(String name){
        return name;

    }
}

上面代码写在一个Doc.java文件中,在计算机的目录中找到该文件,并在地址栏中最前面输入cmd+空格键,即可打开cmd窗口,并自动定位到当前目录
在这里插入图片描述
cmd窗口如下:
在这里插入图片描述
在该目录下输入命令javadoc -encoding UTF-8 -charset UTF-8 Doc.java
javadoc将你 Java 程序的源代码作为输入,输出一些包含你程序注释的HTML文件
Doc.java为java文件名,中间是编码参数
执行命令:
在这里插入图片描述
最后进入java文件所在的目录找到名为index.html的文件并打开。里面展示的就是关于这个Doc类的注释说明
在这里插入图片描述
通过idea生成javaDoc文档
IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。
在这里插入图片描述
javadoc是一个新建的文件夹,用于存放生成的文档
Generate JavaDoc scope表示生成javaDoc文档的范围,这里选择以java文件来生成
Locale表示需要生成的 JavaDoc 以何种语言版本展示,如果不填,默认可能是英文或者是当前操作系统的语言,这里填写zh_CN
Other command line arguments表示的是执行的时候传入的参数:
第一个参数 -encoding UTF-8 表示你的源代码(含有符合 JavaDoc 标准的注释)是基于 UTF-8 编码的,以免处理过程中出现中文等非英语字符乱码;第二个参数 -charset UTF-8 表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码,目前所有浏览器都支持 UTF-8,这样最具有通用性,支持中文非常好.

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值