什么是javadoc？

2024-04-17 14:39:00

1.什么是javadoc？

Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。
JBuilder提供了多项对Javadoc支持的功能，可以通过向导在工程窗格的树中创建Javadoc的节点，通过节点的菜单命名创建工程的Javadoc文档，可以通过诱导的方式录入Javadoc的标签，检验注释是否和源代码相匹配等。

2.使用方法

使用命令行在目标文件所在目录输入javadoc +文件名.java。

3.常用符

@author
作者标识

@version
版本号

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

@return
对函数返回值的注释。

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

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

@exception
和@throws是相同的。

@see
查看相关内容，如类、方法、变量等。

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

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

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

什么是javadoc？相关推荐

Java8(jdk1.8)中文档注释处理工具javadoc的环境参量配置及使用方法
Java8(jdk1.8)中文档注释处理工具javadoc的环境参量配置及使用方法 Java语言提供了一种功能强大的注释形式:文档注释.如果编写Java源代码时添加了合适的文档注释,然后通过JDK提供 ...
eclipse怎样生成javadoc
使用eclipse生成文档(javadoc)主要有三种方法:1.在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步. 在Jav ...
java一般会写javadoc吗_怎么写javadoc
展开全部你好,这个的话,可以配置标准化的模板62616964757a686964616fe4b893e5b19e31333335336533,你可以参考,不让我传附件,粘贴到下面了设置注释模板的入口 ...
maven 下载源码和javadoc命令
1:Maven命令下载源码和javadocs 当在IDE中使用Maven时如果想要看引用的jar包中类的源码和javadoc需要通过maven命令下载这些源码,然后再进行引入,通过mvn命令能够容易的 ...
JavaDoc注释的使用
JavaDoc注释的使用 2009-06-16 11:29 woaidongmao cpp博客我要评论(0) 字号:T | T Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类.方法 ...
利用Javadoc工具生成api文档
2019独角兽企业重金招聘Python工程师标准>>> step1:将写好的程序源码存入某路径下 step2:cmd进入该路径 step3:执行命令生成api文档命令:javad ...
使用eclipse生成html格式注释文档 [ javadoc ]
前言近期组织翻译Android一直在苦恼如何更加便利的进行翻译工作,当前形式为将页面上的API复制到WORD中再进行翻译,最麻烦的是格式问题,这里探索一下是不是我们可以直接在源码上进行翻译,然后利用 ...
Javadoc代码追踪记录
1.javadoc源代码: svn co http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-javadoc-plugin 2.安装到本 ...
Android基于mAppWidget实现手绘地图（四）--如何附加javadoc
如何把javadoc添加到代码库中? How to attach javadoc to the library? 项目属性-->Java Build Path-->Libraries.选择 ...
java注释风格与javadoc
javadoc做注释一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档通常这种注释的多行写法如下 ...

最新文章

热门文章