前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >大数据必学Java基础(八):简单介绍API和注释

大数据必学Java基础(八):简单介绍API和注释

原创
作者头像
Lansonli
发布2022-07-04 09:21:24
4020
发布2022-07-04 09:21:24
举报
文章被收录于专栏:Lansonli技术博客

​简单介绍API和注释

一、API

  • JDK帮助文档
  • SUN公司为JDK工具包提供了一整套文档资料,我们习惯上称之为JDK文档。
  • JDK文档中提供了Java中的各种技术的详细资料,以及JDK中提供的各种类的帮助说明。
  • JDk文档是Java语言的完整说明,大多数书籍中的类的介绍都要参照它来完成,它是编程者经常查阅的资料
  • 如何理解API:就当做是一个“字典”,“使用手册”,API就相当于是一个电子的帮助文档,可以帮我们查看JDK提供的类的信息,平时查看的时候可结合百度一起看。

其实API没有什么神奇的,就是一个电子文档而已,帮助我们查看JAVA中涉及到的一些技能点

代码量统计工具

二、注释

为了方便程序的阅读,Java语言允许程序员在程序中写上一些说明性的文字,用来提高程序的可读性,这些文字性的说明就称为注释。

注释不会出现在字节码文件中,即Java编译器编译时会跳过注释语句。

在Java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。

  • 单行注释

单行注释使用“//”开头,“//”后面的单行内容均为注释。

  • 多行注释

多行注释以“/*”开头以“*/”结尾,在“/*”和“*/”之间的内容为注释,我们也可以使用多行注释作为行内注释。但是在使用时要注意,多行注释不能嵌套使用。

  • 文档注释

文档注释以“/**”开头以“*/”结尾, 注释中包含一些说明性的文字及一些JavaDoc标签(后期写项目时,可以生成项目的API)

单行注释和多行注释

代码语言:javascript
复制
//下面是一段标准代码
//这是代码的“框子”,当前阶段你可以当做一个模板
//其实这就是一个类,类的名字是HelloWorld,这个名字可以随便起,但是一般首字母大写,驼峰命名,见名知意
public class HelloWorld{
        //下面是一个main方法,方法的格式是固定的
        public static void main(String[] args){
                //下面这句话的作用:将双引号中的内容进行原样输出
                /*
                这是多行注释
                每行都可以写
                单行注释和多行注释,按照你自己的需求去使用即可
                */
                System.out.println("hi....java");
        }
}

注意:

1.注释不会参与编译,编译后产生的字节码文件中不会有注释的内容

2.注释的作用:

注释就起到了标注解释的作用,提高代码的可读性,方便自己,方便他人,是一个非常良好,非常专业的习惯。

方便代码的调试。

代码语言:javascript
复制
public class HelloWorld2{
        public static void main(String[] args){	
                System.out.println("hi....java1");
                //System.out.println("hi....java2")
                System.out.println("hi....java3");
        }
}

文档注释

代码语言:javascript
复制
/**
文档注释
@author zhaoss
@version 1.0
这是我们第一章文档注释的代码,比较重要
*/
public class HelloWorld3{
        public static void main(String[] args){	
               System.out.println("hi....java1");	
        }
        /**
        @param name 姓名
        @param age 年龄
        */
        public void eat(String name,int age){
                System.out.println("hello");	
        }
}

一般文档注释可以配合:jdk提供的工具javadoc.exe来一起使用,通过javadoc.exe可以对文档注释进行解析,生成一套以网页文件形式体现的该程序的说明文档。(自定义类对应的API)

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • ​简单介绍API和注释
    • 一、API
      • 二、注释
        • 单行注释和多行注释
        • 文档注释
    领券
    问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档