jdkjavadoc的简单介绍

今天给各位分享jdkjavadoc的知识,其中也会对进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!

本文目录一览:

1、jdk工具javadoc的作用2、JDK JavaDoc有什么用3、jdk是什么4、java高手:javadoc 在哪个文件夹中,它的作用是什么5、如何用javadoc生成jdk api6、openjdk javadoc在哪

jdk工具javadoc的作用

JDK(Java Development Kit,Java开发bai包)包括开发工具和java运行环境两部分du(JRE Java Runtime Everoment)两部分,是java的核心包zhi.开发时用到的一些比较基dao本的工具也包含在里面了.ujiuye

JavaDoc就是JDK中的一个开发工具,可以通过JavaDoc自动提取在程序(*.java文件)中的注释,直接生成帮助文档(Java API)。

jdkjavadoc的简单介绍

JDK JavaDoc有什么用

JDK是一个工具包,里面包括很多高级Java开发时需要用到程序库和调试工具,比如虚拟机监控工具、内存工具、编码工具、打包工具、文档工具等等。其中的javadoc就是文档工具,用来自动根据代码中的带有特定格式的注释来生成HTML格式的文档。典型的一个例子就是Java官网的API解释。这些文档就是根据Java源代码中的注释自动生成的。

jdk是什么

JDK(Java Development Kit)是Sun微系统针对Java开发人员发布的免费软件开发工具包(SDK,Software development kit)。自从Java推出以来,JDK已经成为使用最广泛的Java SDK。

JDK包含了一批用于Java开发的组件,其中包括:

javac:编译器,将后缀名为.java的源代码编译成后缀名为“.class”的字节码

java:运行工具,运行.class的字节码

jar:打包工具,将相关的类文件打包成一个文件

javadoc:文档生成器,从源码注释中提取文档,注释需符合规范

jdb debugger:调试工具

jps:显示当前java程序运行的进程状态

javap:反编译程序

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标签可以使你随时随地在需要的地方作上标记,不至于遗漏未尽的工作。

如何用javadoc生成jdk api

注意:本经验使用的eclipse版本为

Eclipse Java EE IDE for Web Developers.

Version: Luna Service Release 1 (4.4.1)

Build id: 20140925-1800

打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/

javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。

点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。

(1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。

(5)点击【Next】按钮

(1)勾选Document Title,然后填写文档标题。

(2)点击【Next】按钮

(1)选择使用的jdk版本

(2)点击【Finish】按钮

可以看到控制台输出生成javadoc的信息。

项目下生成一个【doc】的目录,里面存放着javadoc文档。

打开doc目录,用浏览器打开index.html

可以看到一个完整的API文档、javadoc就生成了。

openjdk javadoc在哪

请参考OpenJDK8u最新版的javadoc的实现:

不过要注意的是OpenJDK(也传递到Oracle JDK)的javadoc是在javac的基础上实现的。而javac的源码在隔壁的另一个目录里:

jdk8u/jdk8u/langtools: 2baeb96fa198 /src/share/classes/com/sun/tools/javac/

其中javac的parser在com.sun.tools.javac.parser包下,而AST类型声明在com.sun.tools.javac.tree包下。

javadoc要先让javac把源码的语法分析(parse)做好,得到里面的javadoc注释之后,再由javadoc自己的逻辑去分析注释里的内容并且生成HTML文档文件。

关于jdkjavadoc和的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站。

本文来自投稿,不代表【】观点,发布者:【

本文地址: ,如若转载,请注明出处!

举报投诉邮箱:253000106@qq.com

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2024年4月1日 04:27:23
下一篇 2024年4月1日 04:32:30

相关推荐

  • c语言mallloc使用的简单介绍

    C语言中使用malloc必须加#includemallo.h? 1、在C语言中使用malloc函数进行动态内存分配。malloc的全称是memory allocation,中文叫动态内存分配。原型:extern void malloc(unsigned int num_bytes);功能:分配长度为num_bytes字节的内存块。 2、你可以看一下C语言那本…

    2024年5月23日
    4500
  • javascriptcanvas的简单介绍

    如何使用js在画布上绘制图形 1、可以使用 drawImage()方法把一幅图像绘制到画布上。 以使用三种不同的参数组合。最简单的调用方式是传入一个 HTML 元素,以及绘制该图像的起点的 x 和 y 坐标。 2、效果图:使用JavaScript在画布中绘制文本图形首先我们来看看要在画布上绘制文本图形,需要用到的最重要的属性和方法:font属性:定义文本的字…

    2024年5月23日
    4200
  • cortexm4linux的简单介绍

    Cortex-M4的主要功能 Cortex-M4提供了无可比拟的功能,以将[1] 32位控制与领先的数字信号处理技术集成来满足需要很高能效级别的市场。 Cortex-M4核心具有浮点单元(FPU)单精度,支持所有Arm单精度数据处理指令和数据类型。它还实现了一套完整的DSP指令和一个提高应用程序安全性的内存保护单元(MPU)。 主要是m4比m3多了dsp的支…

    2024年5月23日
    4400
  • 3desjavaphp的简单介绍

    php的3des加密结果与java不一致 他们的加密算法都是通用的,是可以解开的,只要你des的模式,加密长度,初始向量什么的都一样就可以。 JAVA写RSA加密,私钥都是一样的,公钥每次加密的结果不一样跟对数据的padding(填充)有关。Padding(填充)属性定义元素边框与元素内容之间的空间。padding简写属性在一个声明中设置所有内边距属性。 要…

    2024年5月23日
    4900
  • 黑客代码软件学习推荐歌曲的简单介绍

    我想自学编程代码,,目地是“黑”网站,开发出破解代码。有没有这方面的… 这个迭代周期不应该以周为周期或以月为周期发生,而是应该以日为周期。知识等待使用的时间越久,知识这把斧头就越钝。等待学习新知识的时间越长,你就越难以将其融入到代码中。 我认为这个问题问得本身就显得有点矛盾,想学却担心自己看不懂代码学不来,试问哪个编程人员不是从零开始的。坚定信念…

    2024年5月23日
    4800
  • java8种基本类型范围的简单介绍

    java中常用的数据类型有哪些 1、java数据类型分为基本数据类型和引用数据类型,基本数据类型有boolean 、long 、int 、char、byte、short、double、float。引用数据类型有类类型、接口类型和数组类型。 2、java中包含的基本数据类型介绍:\x0d\x0aJava共支持8种内置数据类型。内置类型由Java语言预先定义好,…

    2024年5月23日
    4900
  • linux系统与gpt的关系的简单介绍

    linux下查看分区是不是gpt 看分区会报错,比如:WARNING: GPT (GUID Partition Table) detected on /dev/sda! The util fdisk doesnt support GPT. Use GNU Parted.所以这个sda就是gpt的。 选择“管理”;在“磁盘管理”中,右键“磁盘0”,在弹出的右键…

    2024年5月23日
    5400
  • 北京黑客学习培训的简单介绍

    现在学什么好啊 包括建筑设计、服装设计、珠宝首饰设计等,选择适合自己的设计专业,好好学习,就业容易且收入高。学前教育专业:很多女生喜欢小孩子,且女生一般细心且有耐心,教育行业假期宽裕,工作环境单纯,就业机会多。 现在比较热门好就业的专业有人工智能、机械专业、电子商务专业、人力资源专业、金融学专业、小语种类专业等等。人工智能:人工智能领域的研究包括机器人、语言…

    2024年5月23日
    4200
  • javaee要学那些东西的简单介绍

    java主要学习哪些内容 1、学java最重要的是下面四个内容:掌握Java语言的使用:语言语法、程序逻辑,OOP(面向对象)思想,封装、继承、多态,集合框架、泛型、File I\O技术,多线程技术、socket网络编程,XML技术。 2、Java基础:了解Java的基本语法、数据类型、控制流程、数组、字符串等基础概念。学习面向对象编程(OOP)的原则和概念…

    2024年5月23日
    4300
  • excel自杀的简单介绍

    excel表格中宏代码,具有自杀功能,密码输入错误3次就自动删除表格_百度… 我给楼主一个建议,利用excel自身的密码保护,保护此工作簿的结构,将sheet提前隐藏。这样如果有人将同一份excel打开时,如果不能输入正确的密码,就不能将sheet取消隐藏,就能达到楼主所说的保护了。 如果你还有源文件的话,可以这样试试:打开其他的excel文件,…

    2024年5月23日
    8100

发表回复

登录后才能评论



关注微信