javadoc 是什么(JDK JavaDoc有什么用)
其实javadoc 是什么的问题并不复杂,但是又很多的朋友都不太了解JDK JavaDoc有什么用,因此呢,今天小编就来为大家分享javadoc 是什么的一些知识,希望可以帮助到大家,下面我们一起来看看这个问题的分析吧!
java高手:javadoc 在哪个文件夹中,它的作用是什么
在JDK目录下的bin子目录中
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标签可以使你随时随地在需要的地方作上标记,不至于遗漏未尽的工作。
JDK JavaDoc有什么用
JDK是一个工具包,里面包括很多高级Java开发时需要用到程序库和调试工具,比如虚拟机监控工具、内存工具、编码工具、打包工具、文档工具等等。其中的javadoc就是文档工具,用来自动根据代码中的带有特定格式的注释来生成HTML格式的文档。典型的一个例子就是Java官网的API解释。这些文档就是根据Java源代码中的注释自动生成的。
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>输出编码名称
找不到javadoc是什么意思
问题您表述的并不清楚,我理解是,你在一个集成开发环境中,比如eclipse,定位某个您想获得帮助的api信息,可能你点击F1健或其他类似操作,因为你没有在eclipse等集成开发环境中进行相关的api帮助文档的添加配置,工具找不到,故提示上面的问题。请确定是否是这类问题,然后根据自己使用的ide工具进行这方面问题的解答搜索。
关于javadoc 是什么到此分享完毕,希望能帮助到您。