导航:首页 > 编程语言 > javadoc链接

javadoc链接

发布时间:2024-02-08 17:06:57

『壹』 java的javadoc怎么用

Javadoc是Sun公司提供的一个技术,它从程序代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。
JBuilder提供了多项对Javadoc支持的功能,可以通过向导在工程窗格的树中创建Javadoc的节点,通过节点的菜单命名创建工程的Javadoc文档,可以通过诱导的方式录入Javadoc的标签,检验注释是否和源代码相匹配等。
本文,我们将讲解如何在源代码中用Javadoc标签写注释及如何创建Javadoc文档。
虽然软件工程中把详细设计作为软件项目的一个重要的阶段,但在实践中往往没有得到落实。并不是这个阶段不重要,而是实施有很大的困难,因为软件需求是天生的易动症患者,好不容易详细设计出来后,需求已和当初的版本大相径庭,而花费巨大,精雕细琢的详细设计已变成昨日黄花了。
Javadoc注释由Javadoc标签和描述性文本组成,你可以为类、接口添加注释,也可为构造函数、值域、方法等类中的元素添加注释。
可以通过代码模板快速的录入Javadoc注释,你也可以选择通过Javadoc对话框以一种形象化的方式录入Javadoc注释。此外,JBuilder还提供了各种Javadoc的辅助功能,如JavadocInsight诱导录入,冲突报告和更正,特殊的todo标签等。
虽然在Java文件中编写注释后,马上可以切换到内容窗格的Doc视图页代码中对应的Javadoc文档,但在Doc视图页中生成的文档仅是不完整的"范本"。首先,没有导航树,其次没有生成通过@see或@link关联内容的链接。所以你可以把Doc视图页中的Javadoc文档看成是Javadoc最终版本的预览。
本文中我们介绍了Javadoc的标签,讲解了如何在JBuilder编辑Javadoc注释,你应该尽量使用JavadocInsight、ClassInsight和ParameterInsight快速而正确地编写Javadoc注释。此外你应该将常用的注释做成模板,方便快速录入。
JBuilder提供的注释冲突报告和恢复的功能可以使你轻松解决注释冲突的问题,免除了单调的手工调整操作。
JBuilder还允许你自定义Javadoc标签,以满足一些个性化的要求。此外JBuilder自定义的todo标签可以使你随时随地在需要的地方作上标记,不至于遗漏未尽的工作。

『贰』 如何使用javadoc命令生成api文档,文档注释

代码如下:

[java]view plain

『叁』 如何使用eclipse生成javadoc帮助文档

首先,打开Eclipse,在需要生成Javadoc的项目上右击鼠标,在弹出来的列表中点击”导出(O)...“选项。

在弹出来的”导出“窗口中,选择导出的目标,这里选择Java文件夹下的Javadoc,然后点击”下一步(N)“按钮。

进入到”选择生成Javadoc的类型“界面,这里默认已经配置好了生成Javdoc的javadoc.exe的路径,如果不对可以重新配置,在“使用标准Doclet(S)”一栏中选择输入Javadoc的目录,默认实在工作空间工程项目下的doc文件夹中,也可以自行配置,然后点击”下一步(N)“按钮。

进入到”配置标准doclet的Javadoc自变量“界面,可以根据需要配置Javadoc的自变量,可以通过”基本选项“下的复选框来选择Javadoc选项。如果想引用一个库中的类,并且将该库链接到它的javadoc,可以在“选择应将链接生成至的被引用归档和项目(R)”列表中选择,然后点击“下一步(N)”按钮。

进入到“配置Javadoc自变量”界面,这里注意:如果项目采用的是UTF-8编码,Extra Javadoc options(额外的Javadoc选项)下需要输入设定参数:-encoding utf-8 -charset utf-8否则生成的网页中文注释都是乱码,点击“完后”按钮。

在点击“完成”按钮后,会看到Eclipse主界面的“控制台”输入Javdoc生成成功的信息。

查看生成的Javadoc帮助文档。
进入到工作空间对应的工程项目下,可以看到有个doc文件夹(当然这是默认的输出目录,如果你在生成Javadoc时设置了其它目录,可以进相应的目录中)。

点击进度doc文件夹,会发现doc文件夹中有好多.html文件,打开index.html文件。

可以看到生成的API文档,这里面显示了过程中的相应信息。

点击其中的类,可以看到相应类的信息,如你设置的版本、作者,还可以看到继承的类等信息,有助于快速了解源代码。

『肆』 javadoc.exe 是什么啊

从源程序中提取java文档,就像我们所看到的 SUN的API文档一样,把你的类、方法、变量全部放进去一个超链接中,方便用户查阅。

下面是调试信息:

用法:javadoc [选项] [软件包名称] [源文件] [@file]
-overview <文件> 读取 HTML 文件的概述文档
-public 仅显示公共类和成员
-protected 显示受保护/公共类和成员(默认)
-package 显示软件包/受保护/公共类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet <类> 通过替代 doclet 生成输出
-docletpath <路径> 指定查找 doclet 类文件的位置
-sourcepath <路径列表> 指定查找源文件的位置
-classpath <路径列表> 指定查找用户类文件的位置
-exclude <软件包列表> 指定要排除的软件包的列表
-subpackages <子软件包列表> 指定要递归装入的子软件包
-breakiterator 使用 BreakIterator 计算第 1 句
-bootclasspath <路径列表> 覆盖引导类加载器所装入的
类文件的位置
-source <版本> 提供与指定版本的源兼容性
-extdirs <目录列表> 覆盖安装的扩展目录的位置
-verbose 输出有关 Javadoc 正在执行的操作的消息
-locale <名称> 要使用的语言环境,例如 en_US 或 en_US_WIN
-encoding <名称> 源文件编码名称
-quiet 不显示状态消息
-J<标志> 直接将 <标志> 传递给运行时系统

通过标准 doclet 提供:
-d <directory> 输出文件的目标目录
-use 创建类和包用法页面
-version 包含 @version 段
-author 包含 @author 段
-docfilessubdirs 递归复制文档文件子目录
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题
-doctitle <html-code> 包含概述页面的标题
-header <html-code> 包含每个页面的页眉文本
-footer <html-code> 包含每个页面的页脚文本
-top <html-code> 包含每个页面的顶部文本
-bottom <html-code> 包含每个页面的底部文本
-link <url> 创建指向位于 <url> 的 javadoc 输出的链接
-linkoffline <url> <url2> 利用位于 <url2> 的包列表链接至位于 <url> 的文档
-excludedocfilessubdir <name1>:..排除具有给定名称的所有文档文件子目录。
-group <name> <p1>:<p2>..在概述页面中,将指定的包分组
-nocomment 不生成描述和标记,只生成声明。
-nodeprecated 不包含 @deprecated 信息
-noqualifier <name1>:<name2>:...输出中不包括指定限定符的列表。
-nosince 不包含 @since 信息
-notimestamp 不包含隐藏时间戳
-nodeprecatedlist 不生成已过时的列表
-notree 不生成类分层结构
-noindex 不生成索引
-nohelp 不生成帮助链接
-nonavbar 不生成导航栏
-serialwarn 生成有关 @serial 标记的警告
-tag <name>:<locations>:<header> 指定单个参数自定义标记
-taglet 要注册的 Taglet 的全限定名称
-tagletpath Taglet 的路径
-charset <charset> 用于跨平台查看生成的文档的字符集。
-helpfile <file> 包含帮助链接所链接到的文件
-linksource 以 HTML 格式生成源文件
-sourcetab <tab length> 指定源中每个制表符占据的空格数
-keywords 使包、类和成员信息附带 HTML 元标记
-stylesheetfile <path> 用于更改生成文档的样式的文件
-docencoding <name> 输出编码名称

『伍』 java source Attachment 和 javadoc Location 各指什么它们在哪个文件夹中了谢谢

java
source
Attachment
是寻找源码,如果Jar包或class文件有源码的话,指定源码所在地址就可以专链接到源码。属javadoc
location
是Java注释文件可以帮助你查找各个函数和类的注释,我知道的就这些。

『陆』 eclipse内部Javadoc怎么汉化成中文

首先到oracle官网jdk/jdk-api-localizations/jdk-api-zh-cn/publish/1.6.0/html_zh_CN.zip下载中文的JavaDOC,版本为javaSE6.0。

然后在Eclipse中选择内window-->Preferences-->java-->Instralls JRES

然后点击jre6.0,选择右容边的Edit

在弹出的窗体中选择rt.jar后点击Javadoc Location:

选择下面的Javadoc in archive ,在Archive path中选择下载到的html_zh_CN.zip的路径,然后点击Path within archive右边的Browse

点击图中的树状结构选择到api节点为止后,点击所有的弹出窗体的ok按钮。

『柒』 怎么设置,可以使eclipse里面的api提示变成中文

  1. 首先要下载Eclipse的中文api,下载完成后,打开Eclipse软件,下载链接:http://download.java.net/jdk/jdk-api-localizations/jdk-api-zh-cn/publish/1.6.0/html_zh_CN.zip

  2. 在【窗口】菜单中找到【首选项】,单击【首选项】

  3. 在【Java】下找到【已安装的JRE】,点击里面【已安装的JRE】点击【编辑】,找到/lib/rt.jar选项和/lib/jsse.jar选项,做以下同样的操作,选中源代码链接->单击【移除】,选中刚移除选项的下一个选项,然后单击【Javadoc位置】,单击【浏览】,找到之前下载的Eclipse的中文api,要一直到“api”路径,然后点击【确定】,点击【测试】看看我们选择的路径是否正确,若正确点击【确定】,关闭弹出窗口,再点击【确定】

  4. 对两个选项都设置完成后,再单击【确定】,即完成了对Eclipse的全部设置,现在把鼠标放在代码上,就会出现中文的提示了。

详细设置参考链接:http://jingyan..com/article/c275f6bacb4425e33d7567b6.html

『捌』 java中如何自动生成注释

你说的应该是生成javadoc吧?

最简单方式就是使用命令行, cd到你的项目源代码目录下, 输入如下指令:

javadoc-ddocs-subpackagescom.yourpackage

其中-d docs指定了生成的javadoc在相对目录docs下, -subpackages com.yourpackage指定了你要被生成javadoc的源代码包.


JAVADOC是官方提供的一种生成注释文档的工具, 他的用法如下:

用法:javadoc[options][packagenames][sourcefiles][@files]
-overview<file>从HTML文件读取概览文档
-public仅显示public类和成员
-protected显示protected/public类和成员(默认值)
-package显示package/protected/public类和成员
-private显示所有类和成员
-help显示命令行选项并退出
-doclet<class>通过替代doclet生成输出
-docletpath<path>指定查找doclet类文件的位置
-sourcepath<pathlist>指定查找源文件的位置
-classpath<pathlist>指定查找用户类文件的位置
-cp<pathlist>指定查找用户类文件的位置
-exclude<pkglist>指定要排除的程序包列表
-subpackages<subpkglist>指定要递归加载的子程序包
-breakiterator计算带有BreakIterator的第一个语句
-bootclasspath<pathlist>覆盖由引导类加载器所加载的
类文件的位置
-source<release>提供与指定发行版的源兼容性
-extdirs<dirlist>覆盖所安装扩展的位置
-verbose输出有关Javadoc正在执行的操作的信息
-locale<name>要使用的区域设置,例如en_US或en_US_WIN
-encoding<name>源文件编码名称
-quiet不显示状态消息
-J<flag>直接将<flag>传递到运行时系统
-X输出非标准选项的提要

通过标准doclet提供:
-d<directory>输出文件的目标目录
-use创建类和程序包用法页面
-version包含@version段
-author包含@author段
-docfilessubdirs递归复制文档文件子目录
-splitindex将索引分为每个字母对应一个文件
-windowtitle<text>文档的浏览器窗口标题
-doctitle<html-code>包含概览页面的标题
-header<html-code>包含每个页面的页眉文本
-footer<html-code>包含每个页面的页脚文本
-top<html-code>包含每个页面的顶部文本
-bottom<html-code>包含每个页面的底部文本
-link<url>创建指向位于<url>的javadoc输出的链接
-linkoffline<url><url2>利用位于<url2>的程序包列表链接至位于<url>的文档
-excludedocfilessubdir<name1>:..排除具有给定名称的所有文档文件子目录。
-group<name><p1>:<p2>..在概览页面中,将指定的程序包分组
-nocomment不生成说明和标记,只生成声明。
-nodeprecated不包含@deprecated信息
-noqualifier<name1>:<name2>:...输出中不包括指定限定符的列表。
-nosince不包含@since信息
-notimestamp不包含隐藏时间戳
-nodeprecatedlist不生成已过时的列表
-notree不生成类分层结构
-noindex不生成索引
-nohelp不生成帮助链接
-nonavbar不生成导航栏
-serialwarn生成有关@serial标记的警告
-tag<name>:<locations>:<header>指定单个参数定制标记
-taglet要注册的Taglet的全限定名称
-tagletpathTaglet的路径
-charset<charset>用于跨平台查看生成的文档的字符集。
-helpfile<file>包含帮助链接所链接到的文件
-linksource以HTML格式生成源文件
-sourcetab<tablength>指定源中每个制表符占据的空格数
-keywords使程序包,类和成员信息附带HTML元标记
-stylesheetfile<path>用于更改生成文档的样式的文件
-docencoding<name>指定输出的字符编码
阅读全文

与javadoc链接相关的资料

热点内容
微信的排版工具 浏览:336
电脑装机提示系统配置文件不存在 浏览:572
linux强制杀死线程 浏览:456
哪里有数控车床编程服务 浏览:408
爱奇艺视频传到iphone 浏览:331
图片转成pdf文件有妙招 浏览:761
yy女主播31分钟版密码 浏览:825
ug编程在哪里设置安全距离 浏览:110
js数值取整数部分 浏览:704
如何调用另外一个表格中的数据 浏览:353
centos文件在哪个文件夹 浏览:466
设置文件排列顺序 浏览:87
cs6里没有标尺工具 浏览:976
keilarm启动文件夹 浏览:631
fatfs文件系统手册 浏览:251
iphone6s拍照会动 浏览:5
平安养老富盈5号微信 浏览:715
慧政仁通app有哪些功能 浏览:223
网络配置文件刷新 浏览:605
java文件上传时指定路径 浏览:436

友情链接