javadoc 原

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。

javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java

标签

说明

JDK 1.1 doclet

标准doclet

标签类型

@author 作者

作者标识

包、 类、接口

@version 版本号

版本号

包、 类、接口

@param 参数名 描述

方法的入参名及描述信息,如入参有特别要求,可在此注释。

构造函数、 方法

@return 描述

对函数返回值的注释

方法

@deprecated 过期文本

标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。

包、类、接口、值域、构造函数、 方法

@throws异常类名

构造函数或方法所会抛出的异常。

构造函数、 方法

@exception 异常类名

同@throws。

构造函数、 方法

@see 引用

查看相关内容,如类、方法、变量等。

包、类、接口、值域、构造函数、 方法

@since 描述文本

API在什么程序的什么版本后开发支持。

包、类、接口、值域、构造函数、 方法

{@link包.类#成员 标签}

链接到某个特定的成员对应的文档中。

包、类、接口、值域、构造函数、 方法

{@value}

当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。

√(JDK1.4)

静态值域

此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,由于不常使用,我们展开叙述,感兴趣的读者可以查看帮助文档。

          

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 胡烁学记:技术开发行业7种典型客户的谈单应对技巧

    沉默型客户分为3种。第一种,聊了几句后没兴趣的客户,采取冷处理,也就是先做好记录给对方留下好的印象;第二种,聊了几句不知道怎么聊了,迷茫型客户;第三种,去忙别的...

    wuweixiang
  • swagger-ui教程-构建api接口文档工具

    之前写过关于app后端开发的一系列文章,那是我第一次做app后端开发,存在很多不足,本想好好修改一下,想想还是重新写吧,这样子也能让我博客文章看起来多一点嘛,万...

    wuweixiang
  • 软件销售的逼单技巧?——价值百万的逼单讲解 转

    为什么说是整个过程呢?而不是单单只讲逼单呢?我可以很明确的告诉你逼单是到了整个销售流程最后面的环节、如果你前端做不好,后端也想让客户给你买单难、很难。那么前端要...

    wuweixiang
  • ROI操作:ROIPooling和ROIAlign

    目标:为了使得检测网络可以输入任意size的图片,使用ROIPooling在网络中某一个阶段将不同尺度的图片ROI pooling成相同的尺度,使得fc的存在也...

    AI深度学习求索
  • web前端工程师入门须知,你全部了解吗?

    划重点 一名合格的web前端工程师必须得掌握HTML、CSS和JavaScript。只懂其中一个或两个还不行,你必须对这三门语言都很熟悉。也不是说必须对这三门语...

    企鹅号小编
  • 如何用 R 绘制交互式社会网络图?

    最近有个学生问我,如何绘制交互式社会网络图(Interactive Social Network Graph)?

    王树义
  • 全栈工程师的百宝箱:黑魔法之文档篇

    今天收集Session数据的时候收集到了这样的一条,就是“全栈工程师的工具箱”。星期一又想不到什么可以写的内容,就来这样的一篇好了。 以下的内容都是压箱底的,...

    Phodal
  • 面试| Python 自动化测试面试经典题目回顾

    1、super 是干嘛用的?在 Python2 和 Python3 使用,有什么区别?为什么要使用 super?请举例说明。

    霍格沃兹测试开发
  • 全栈工程师的百宝箱:黑魔法之文档篇

    今天收集Session数据的时候收集到了这样的一条,就是“全栈工程师的工具箱”。星期一又想不到什么可以写的内容,就来这样的一篇好了。 以下的内容都是压箱底的,...

    Rainbond开源
  • java.lang.IllegalStateException: Unable to find a @SpringBootConfiguration

    DencyCheng

扫码关注云+社区

领取腾讯云代金券