2020会声会影下载

绘声绘影 | 会声会影破解版 | 会声会影下载

当前位置:首页 > 教程资讯 > 软件教程 win10专业版

Java的doc(文档注释)详解

Java的doc(文档注释)详解

分类:软件教程

来源:电脑软件

作者:杀毒软件

时间:2021-04-01

资讯内容

Javadoc标签

Javadoc 工具可以识别文档注释中的一些特殊标签,这些标签一般以@开头,后跟一个指定的名字,有的也以{@开头,以}结束。Javadoc 可以识别的标签如下表所示:
 
标签 描述 示例
@author 标识一个类的作者,一般用于类注释 @author description
@deprecated 指名一个过期的类或成员,表明该类或方法不建议使用 @deprecated description
{@docRoot} 指明当前文档根目录的路径 Directory Path
@exception 可能抛出异常的说明,一般用于方法注释 @exception exception-name explanation
{@inheritDoc} 从直接父类继承的注释 Inherits a comment from the immediate surperclass.
{@link} 插入一个到另一个主题的链接 {@link name text}
{@linkplain} 插入一个到另一个主题的链接,但是该链接显示纯文本字体 Inserts an in-line link to another topic.
@param 说明一个方法的参数,一般用于方法注释 @param parameter-name explanation
@return 说明返回值类型,一般用于方法注释,不能出现再构造方法中 @return explanation
@see 指定一个到另一个主题的链接 @see anchor
@serial 说明一个序列化属性 @serial description
@serialData 说明通过 writeObject() 和 writeExternal() 方法写的数据 @serialData description
@serialField 说明一个 ObjectStreamField 组件 @serialField name type description
@since 说明从哪个版本起开始有了这个函数 @since release
@throws 和 @exception 标签一样. The @throws tag has the same meaning as the @exception tag.
{@value} 显示常量的值,该常量必须是 static 属性。 Displays the value of a constant, which must be a static field.
@version 指定类的版本,一般用于类注释 @version info

对两种标签格式的说明:
  • @tag 格式的标签(不被{ }包围的标签)为块标签,只能在主要描述(类注释中对该类的详细说明为主要描述)后面的标签部分(如果块标签放在主要描述的前面,则生成 API 帮助文档时会检测不到主要描述)。
  • {@tag} 格式的标签(由{ }包围的标签)为内联标签,可以放在主要描述中的任何位置或块标签的注释中。

Javadoc 标签注意事项:
  • Javadoc 标签必须从一行的开头开始,否则将被视为普通文本。
  • 一般具有相同名称的标签放在一起。
  • Javadoc 标签区分大小写,代码中对于大小写错误的标签不会发生编译错误,但是在生成 API 帮助文档时会检测不到该注释内容。

Javadoc命令

Javadoc 用法格式如下:

javadoc [options] [packagenames] [sourcefiles]

对格式的说明:
  • options 表示 Javadoc 命令的选项;
  • packagenames 表示包名;
  • sourcefiles 表示源文件名。

在 cmd(命令提示符)中输入javadoc -help就可以看到 Javadoc 的用法和选项(前提是安装配置了JDK),下面列举 Javadoc 命令的常用选项:
 
名称 说明
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员(默认值)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-d <directory> 输出文件的目标目录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题

DOS命令生成API帮助文档 

新建一个空白记事本,输入下列代码: 

 
  1. /**
  2. * @author C语言中文网
  3. * @version jdk1.8.0
  4. */
  5. public class Test{
  6. /**
  7. * 求输入两个参数范围以内整数的和
  8. * @param n 接收的第一个参数,范围起点
  9. * @param m 接收的第二个参数,范围终点
  10. * @return 两个参数范围以内整数的和
  11. */
  12. public int add(int n, int m) {
  13. int sum = 0;
  14. for (int i = n; i <= m; i++) {
  15. sum = sum + i;
  16. }
  17. return sum;
  18. }
  19. }

将文件命名为 Test.java,打开 cmd 窗口,输入javadoc -author -version Test.java命令。如图 1 所示。


图 1  cmd 运行窗口
打开 Test.java 文件存储的位置,会发现多出了一个 Test.html 文档。打开文档,文档页面如图 2 和图 3 所示。


图 2  Student.html 页面(1)
 

图 3  Student.html 页面(2)
注意:以上没有考虑编码格式的问题,注释中有汉字可能会乱码。使用javadoc -encoding UTF-8 -charset UTF-8  Test.java会解决编码问题。

MyEclipse生成API帮助文档

1)在 MyEclipse 中新建一个 Test 类,代码如下:

 
  1. package test;
  2.  
  3. /**
  4. * @author C语言中文网
  5. * @version jdk1.8.0
  6. */
  7. public class Test {
  8. public static void main(String[] args) {
  9. /**
  10. * 这是一个输出语句
  11. */
  12. System.out.println("C语言中文网Java教程访问地址:http://c.biancheng.net/java/");
  13. }
  14. }

注意:代码 9~11 行没有放在类、成员变量或方法之前,所以 Javadoc 会忽略这个注释。

2)在项目名处单击鼠标右键,然后选择Export...,如图 4 所示。

图 4
3)在弹出窗口中选择 Java 文件夹,点击 Java 文件夹下面的 Javadoc,然后点击“Next”,如图 5 所示。


图 5  
4)选择你要生成 Javadoc 的项目,并更改你想保存的 API 帮助文档地址(默认为工程目录下,建议不要修改)。点击“Finish”,如图 6 所示。


图 6  
5)点击“Finish”之后会问是否更新 Javadoc 文件的位置,只需要点击“Yes To All”即可,如图 7 所示。


图 7  
6)这时可以看到控制台输出生成 Javadoc 的信息,如图 8 所示。


图 8  
7)打开保存的文件夹,找到 Test.html 文件并打开,如图 9 所示。


图 9 
以上就是使用 MyEclipse 简单建立一个 API 帮助文档的过程。

文档注释的格式

在编写文档注释的过程中,有时需要添加 HTML 标签,比如:需要换行时,应该使用<br>,而不是一个回车符;需要分段时,应该使用<p>

例如把上面 Test 类改为以下代码:

 
  1. package test;
  2.  
  3. /**
  4. * @author C语言中文网<br>
  5. * 严长生
  6. * @version 1.8.0<br>
  7. * 1.9.0
  8. */
  9. public class Test {
  10. public static void main(String[] args) {
  11. System.out.println("C语言中文网Java教程访问地址:http://c.biancheng.net/java/");
  12. }
  13. }

帮助文档格式如图 10 所示。


图 10 
 
Javadoc 并不是将代码中的文档注释直接复制到帮助文档的 HTML 文件中,而是读取每一行后,删除前面的*号及*以前的空格再输入到 HTML 文档。

/**
* first line.
******* second line.
* third line.
*/

编译输出后的 HTML 源码如下所示。

first line. <br>
second line. <br>
third line.

注释前面的*号允许连续使用多个,其效果和使用一个*号一样,但多个*前不能有其他字符分隔,否则分隔符及后面的*号都将作为文档的内容。
更多精彩:怎么关闭防火墙www.2020win7.com

其他相关

Java_百度搜索

if(window.bds&&bds.util&&bds.util.setContainerWidth){bds.util.setContainerWidth(1280);}老牌系统:www.lpxt.com

输入法

百度首页设置登录新萝卜家园:www.xinluobo.com

网页资讯视频图片知道文库贴吧地图采购更多

{"query":"Java","tn":"baidu","qid":"f0890bed00000987","encTn":"ba14bzHJnAoI5AF+dzf757LJKAzDwyV1yr3q85nNena/R2SV+UPHjpQ7cZY","queryEnc":"Java","inter":"","ubsurl":"https://sp0.baidu.com/5bU_dTmfKgQFm2e88IuM_a/w.gif","cid":"0"}2020win7:www.2020win7.com

{"user":null,"username":"","isLogin":0,"userPortrait":""}

{"isHit": "","mode": "","color": ""}电脑城:www.dncwin10.com

相关计算机软件认证系统:www.rzxt.com

支持Java applet

IntelliJ IDEA快猫:www.km8.net

linux

免费的类Unix操作系统win7:www.win7gw.com

写C代码必备开发工具

PyCharm一键重装:www.xiame.com

servlet

Java编写服务器端程序乡巴佬:www.386w.com

视频和音频流方案

Docker147下载:www.147xz.com

nginx

DOS命令

MATLAB

SolidWorks

keil

微信小程序

相关编程语言

方便快捷的脚本语言

c语言

易语言

一门计算机编程语言

面向机器的编程语言

pascal

static

Ruby

SWIFT

可扩展标记语言

公式翻译器

short

换一换

485万

468万

436万

406万

392万

365万

352万

316万

294万

274万

265万

255万

246万

229万

221万

206万

192万

185万

172万

收起工具时间不限所有网页和文件站点内检索

百度为您找到相关结果约100,000,000个

Java | Oracle

www.java.com/

Java

Java

Java

编程开发

语言特点

语言基础

更多 >

Java

Java培训 血拼120天=2年工作经验+高薪就业 冬季名额限

报名条件:年满18岁 本科及以上学历

活动时间:2020年11月

达内介绍授课讲师合作企业与高校往期薪资学员作品0元试学

tedu.cn

java安装相关博客

Java 开发环境配置菜鸟教程linuxWindowsjava

Java开源中国

windowsjava

macjava

JAVA(windows)安装教程博客园

JAVA环境安装配置CSDN

linuxjava

A.setup(function () {require.config({paths: {"ala_atom/app/open_source_software_blog/index":"//www.baidu.com/cache/ala_atom/app/open_source_software_blog/bundle_c7dd2d2"}});var $container = $(this.container);var selector = this.data.selector;var data = this.data.data || {};var log = this.data.log;var order = this.data.order;var _module = {exports: null};var renderer;(function (module) {module.exports = {render: function () {var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c('App',{attrs:{"url":_vm.url,"title":_vm.title,"blogList":_vm.blogList}})},staticRenderFns: []}})(_module);renderer = _module.exports;function formatName(vm) {if (vm.$root === vm) {return 'root instance';}var name = vm._isVue ? vm.$options.name || vm.$options._componentTag : vm.name;return name ? name : 'anonymous component';}var postedPath = '';function errorCaptured(err, vm, info) {if (info === 'client not match with server' && vm && vm.$parent) {var xpath = formatName(vm);var _vm = vm;while (_vm = _vm.$parent) {xpath = formatName(_vm) + '>' + xpath;}if (!postedPath) {postedPath = xpath;}else if (postedPath.indexOf(xpath) === 0) {return;}err.message = err.message + ' (' + xpath + ')'}require(['atom-logger'], function (logger) {logger.errorHandler(err, vm, info, {card: 'open_source_software_blog',env: log.env});});return false;}var startTime = new Date().getTime();require(['Atom', 'ala_atom/app/open_source_software_blog/index'], function (Atom, App) {var renderStartTime = new Date().getTime();App.name = App.name || 'aladdin-open_source_software_blog';Atom.mixin({created: function () {this.$platform = 'pc';}});var vm = new Atom({el: selector,render: renderer.render,staticRenderFns: renderer.staticRenderFns,created: function () {this.page = bds;this.view = {};},components: {App: App},data: function () {return data;},errorCaptured: errorCaptured,mounted: function () {var mountedTime = new Date().getTime();require(['atom-logger'], function (logger) {logger.performanceHandler && logger.performanceHandler({card: 'open_source_software_blog',order: order,startTime: startTime,renderStartTime: renderStartTime,mountedTime: mountedTime,php: log.cost,env: log.env,data: log.dataCost,json: log.jsonCost});});}});});});

Java - Gitee

Java - Gitee",tabs: [{"star":"Staruff1a21","title":"u7b80u4ecb","watch":"Watchuff1a4","fork":"Forkuff1a13","introduction":"Java u7b97u6cd5u5b9eu73b0u4ee3u7801u96c6","language":"u5f00u53d1u8bedu8a00uff1aJava","license":"u5f00u6e90u534fu8baeuff1aMIT"},{"repo":{"name":"Java","repoUrl":" https://gitee.com/TheAlgorithms/Java?utm_source=alading&utm_campaign=repo ","commit":"Formatted with Google Java Formatter","commitUrl":" https://gitee.com/TheAlgorithms/Java/tree/master/?utm_source=alading&utm_campaign=commitUrl "},"title":"u4ee3u7801u4ed3u5e93"},{"index":{"detail":"Gitee u6307u6570u4e3a 27uff0cu8d85u8fc7 41% u5f00u6e90u9879u76ee","radarChart":"https://talk.gitee.com/alading/radar/1615451754/140a78c3a3cddcb3c5dbd146d7149a43.png","descript#num#baidu":5,"descript":["u4ee3u7801u6d3bu8dc3u5ea6uff1a34uff0cu8d85u8fc7 49% u5f00u6e90u9879u76ee","u793eu533au6d3bu8dc3u5ea6uff1a0uff0cu8d85u8fc7 0% u5f00u6e90u9879u76ee","u56e2u961fu5065u5eb7uff1a90uff0cu8d85u8fc7 97% u5f00u6e90u9879u76ee","u6d41u884cu8d8bu52bfuff1a46uff0cu8d85u8fc7 61% u5f00u6e90u9879u76ee","u5f71u54cdu529buff1a3uff0cu8d85u8fc7 18% u5f00u6e90u9879u76ee"]},"title":"Gitee u6307u6570"}],repo: [{"name":"Java","repoUrl":{"type":"tc","tcUrl":"http://www.baidu.com/link?url=FCQHIILJLj9m6341BuvOotjw8lLaOI1YynSeR1Yc_G92nUbzrku6QZYaaBdXmKy7dWXQTc0LXTmpbvWn2FFkCaK6t8krvbKxEPbeOPW5qsNH5Fqe2dSWNEs3vPUWaW7i"},"commit":"Formatted with Google Java Formatter","commitUrl":{"type":"tc","tcUrl":"http://www.baidu.com/link?url=n0psgLblNneUsDHQO1f_m87jipgXNRQrdnBGz14ghcq7H1Qx78V0e9iPR4PDTWZXj8l1JTG53Lf4HgozVyIOiROlxP_6U13t8H0mQY9gXoTRj2ouDTJte0Qx9xng9ej1AGQleDOjf5Tr_yepgw2-2_"}}],},selector: "[atom-root-6065a45b9a82d]",order: '5',log: {env: 'pc',cost: '0.0017330646514893',jsonCost: '0.08392333984375',dataCost: '0.94819068908691'}});

其他人还在搜

学java要学多久

零基础学java难么

java难学吗

java工程师工资一般多少

编程入门先学什么

java自学成功率

japonensisJAVA性12

Java 教程 Java 是由 Sun Microsystems 公司于 1995 年 5 月推出的高级程序设计语言。 Java 可运行于多个平台,如 Windows, Mac OS 及其他多种 UNIX 版本的系统。 本教程通过简单的实例将让大

Java培训-专业正规IT培训机构「7天免费试学」-北

www.njjava.com/

Java SE - Downloads | Oracle Technology Network | Oracle

www.oracle.com/java/technologi

java

有问题为什么不先问问隔壁C++吧呢?

累计发贴:1096万

新手乐园

javaee

心得分享

Java,半年多的努力没有白费,9K的

点击:2万

java会这些能找到多少钱的工作啊

点击:1728

大伙背面试题,是把答案完完整整背下来呢,还是

点击:3339

java吧的内容 >

tieba.baidu.com/

Java Software | Oracle

www.oracle.com/java/