2023学年完整公开课版文档注释_第1页
2023学年完整公开课版文档注释_第2页
2023学年完整公开课版文档注释_第3页
2023学年完整公开课版文档注释_第4页
2023学年完整公开课版文档注释_第5页
已阅读5页,还剩11页未读 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

文档注释目录Part01教学目标Part02教学内容Part04巩固提高ContentsPart03教学总结Part01教学目标教学目标知识目标文档注释的表示01能力目标能够熟练使用文档注释02Part02教学内容1.为什么使用注释API文档是什么?开发一个大型软件时,需要定义很多类,并且需要很多人员参与。每个人都会开发一些类,并且提供给别人使用,但是其他人怎么知道如何使用这些类和方法呢?这时候就需要提供一份说明文档,用于说明每个类和方法的用途。当其他人使用这个类或方法时,他不需要知道它们的具体实现,只要知道功能即可,也就是通过调用应用程序接口(API)进行编程。API文档就是用以说明这些应用程序接口的文档Java还提供了功能强大的注释——文档注释,如果编写程序时添加了合适的文档注释,通过JDK的javadoc工具可以直接将程序中的文档注释提取生成API文档2.Oracle公司提供的系统API文档下载这个文档下载完毕后,是一个rar文件,对其进行解压,打开docs\api文件夹下的index.html/technetwork/java/javase/downloads/index.html

2.Oracle公司提供的系统API文档Package区域Class区域列举类细节当单击Modules区域中的某个类后,在右侧显示类的具体细节当大家对某个系统类不熟悉时,可以通过查看API文档了解使用方法Modules区域3.使用文档注释/***Description:*@frankzzg@163.com*@version1.0*/publicclassJavadocTagTest{ /** *一个得到打招呼字符串的方法。 *@paramname该参数指定向谁打招呼。 *@return返回打招呼的字符串。 */ publicStringhello(Stringname) { returnname+",你好!"; }}类前的文档注释方法前的文档注释3.使用文档注释将上述文件保存到D盘根目录下,文件名称为javadocTagTest.java打开命令提示符,在D盘下,输入javadocjavadocTagTest.java,则生成API文档打开index.html,则看到javadocTagTest类的具体情况3.使用文档注释文档注释主要用于类、方法和成员变量,Javadoc工具只处理文档源文件在类、接口、方法、成员变量之前的文档注释。java类中只有public和protected修饰的内容才是希望暴露给别人的,因此javadoc默认只处理public和protected修饰的内容。如果确实需要处理private修饰的内容,则需要在使用javadoc工具时增加-private选项Part03教学总结教学总结1.文档注释功能2.系统API文档的下载与使用3.使用

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论