jdk api中文帮助文档
Posted
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了jdk api中文帮助文档相关的知识,希望对你有一定的参考价值。
参考技术A资源来源于网络
百度云链接:
百度云链接
大数据必学Java基础:简单介绍API和注释
简单介绍API和注释
一、API
- JDK帮助文档
- SUN公司为JDK工具包提供了一整套文档资料,我们习惯上称之为JDK文档。
- JDK文档中提供了Java中的各种技术的详细资料,以及JDK中提供的各种类的帮助说明。
- JDk文档是Java语言的完整说明,大多数书籍中的类的介绍都要参照它来完成,它是编程者经常查阅的资料
- 如何理解API:就当做是一个“字典”,“使用手册”,API就相当于是一个电子的帮助文档,可以帮我们查看JDK提供的类的信息,平时查看的时候可结合百度一起看。
其实API没有什么神奇的,就是一个电子文档而已,帮助我们查看JAVA中涉及到的一些技能点
代码量统计工具
二、注释
为了方便程序的阅读,Java语言允许程序员在程序中写上一些说明性的文字,用来提高程序的可读性,这些文字性的说明就称为注释。
注释不会出现在字节码文件中,即Java编译器编译时会跳过注释语句。
在Java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。
- 单行注释
单行注释使用“//”开头,“//”后面的单行内容均为注释。
- 多行注释
多行注释以“/*”开头以“*/”结尾,在“/*”和“*/”之间的内容为注释,我们也可以使用多行注释作为行内注释。但是在使用时要注意,多行注释不能嵌套使用。
- 文档注释
文档注释以“/**”开头以“*/”结尾, 注释中包含一些说明性的文字及一些JavaDoc标签(后期写项目时,可以生成项目的API)
单行注释和多行注释
//下面是一段标准代码
//这是代码的“框子”,当前阶段你可以当做一个模板
//其实这就是一个类,类的名字是HelloWorld,这个名字可以随便起,但是一般首字母大写,驼峰命名,见名知意
public class HelloWorld
//下面是一个main方法,方法的格式是固定的
public static void main(String[] args)
//下面这句话的作用:将双引号中的内容进行原样输出
/*
这是多行注释
每行都可以写
单行注释和多行注释,按照你自己的需求去使用即可
*/
System.out.println("hi....java");
注意:
1.注释不会参与编译,编译后产生的字节码文件中不会有注释的内容
2.注释的作用:
注释就起到了标注解释的作用,提高代码的可读性,方便自己,方便他人,是一个非常良好,非常专业的习惯。
方便代码的调试。
public class HelloWorld2
public static void main(String[] args)
System.out.println("hi....java1");
//System.out.println("hi....java2")
System.out.println("hi....java3");
文档注释
/**
文档注释
@author zhaoss
@version
public class HelloWorld3
public static void main(String[] args)
System.out.println("hi....java1");
/**
@param name 姓名
@param
public void eat(String name,int
System.out.println("hello");
一般文档注释可以配合:jdk提供的工具javadoc.exe来一起使用,通过javadoc.exe可以对文档注释进行解析,生成一套以网页文件形式体现的该程序的说明文档。(自定义类对应的API)
以上是关于jdk api中文帮助文档的主要内容,如果未能解决你的问题,请参考以下文章
java8 JDK1.8 API 中文 翻译版 java帮助文档