Java:API文档;文档注释中的javadoc标记;官方API;自己动手给项目建一个API文档

1、什么是API文档

在Java语言中有3种注释

//单行注释
/*
   多行注释
 */
/**
 * 文档注释
 */

API(应用程序接口)文档就是用javadoc命令提取文档注释生成的,html格式,用浏览器查看。
API文档既然是由文档注释生成的,那么文档注释怎么写呢?
首先,文档注释必须放在类和方法的前面,格式也要准确。
其中,要写清楚类和方法的功能,以及方法传入的形参和返回值具体是什么。
一般来说,只默认提取public和protected修饰的类、接口、方法、成员变量、构造器、内部类的说明。

2、文档注释中的javadoc标记

@author程序作者类/接口的文档注释中
@version程序版本类/接口的文档注释中
@param方法参数说明方法/构造器的文档注释中
@return方法返回值说明方法/构造器的文档注释中
@deprecated该标记用于指出一些旧功能已由改进过的新功能取代该标记的作用是建议用户不 必再使用一种特定的功能,因为未来改版时可能摒弃这一功能。
@exception、@throws抛出的异常方法/构造器的文档注释中

3、官网下载


打开index.html:

4、自己创建一个API文档

javadoc -d apidoc -windowtitle 测试 -doctitle JavaSE学习 -header 侧栏名字 -author basicGrammar/*.java designPatterns/*.java
  • -d :输出文件的目标目录
  • -windowtitle :文档的浏览器窗口标题
  • -doctitle :概览页面的标题
  • -header :每个页面的页眉文本
  • -author:包含 @author 段
  • -version:包含 @version 段
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值