07 JavaDoc

JavaDoc

创建文档注释

  • javadoc命令是用来生成自己API文档的

  • 参数信息

    • @author 作者名
    • @version版本号
    • @since指明需要最早使用的jdk版本
    • @param参数名
    • @return返回值情况
    • @throws异常抛出情况
package com.Tian.base;
/**						类注释
* @author Tiancai		作者
* @version 1.0			版本
* @since 1.8			java版本
*/
public class Doc {
String name;
/**
* author Tiancai		作者
* @param name			参数名
* @return				返回值情况
* @throws Exception		异常抛出情况
*/
pub1ic String test(String name) throws Exception{
	return name ;
}

通过命令行生成API文档

  1. 打开文件所在目录的命令行
  2. 命令格式 javadoc 参数 java文件
  3. 输入命令 javadoc -encoding UTF-8 -charset UTF-8 java文件名
  4. 生成API文档
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

天才东西

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值