当前位置: 首页 > article >正文

Java注释/JDK开发工具生成API/关键字、标识符规范

注释

1.单行注释//

2.多行注释/* */

/* */

中间是被注释的内容。

在中间回车可以变为文档注释。

3.文档注释/** */

可以作为文档导出注释

/**

在末尾回车即可

javadoc工具导出注释
1.文档注释常用标签
  • @param:描述方法参数。

  • @return:描述返回值。

  • @throws:描述可能抛出的异常。

  • @see:添加参考链接。

  • @deprecated:标记方法或类已过时。

2. 使用 javadoc 生成 API 文档
javadoc Student.java

javadoc工具会生成一组 HTML 文件和相关资源文件,这些文件共同构成了完整的 API 文档。

举例:

我们使用文档注释,来输出完整的API文档。

/**
 * 这是一个表示学生的类。
 * 该类包含学生的姓名和年龄信息。
 */
public class Student {
    private String name;
    private int age;
​
    /**
     * 构造方法,用于创建一个学生对象。
     *
     * @param name 学生的姓名
     * @param age  学生的年龄
     */
    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }
​
    /**
     * 获取学生的姓名。
     *
     * @return 学生的姓名
     */
    public String getName() {
        return name;
    }
​
    /**
     * 设置学生的姓名。
     *
     * @param name 学生的姓名
     */
    public void setName(String name) {
        this.name = name;
    }
​
    /**
     * 获取学生的年龄。
     *
     * @return 学生的年龄
     */
    public int getAge() {
        return age;
    }
​
    /**
     * 设置学生的年龄。
     *
     * @param age 学生的年龄
     */
    public void setAge(int age) {
        this.age = age;
    }
​
    /**
     * 返回学生的详细信息。
     *
     * @return 学生的姓名和年龄
     */
    @Override
    public String toString() {
        return "Student{name='" + name + "', age=" + age + "}";
    }
}

3. 生成的文档内容

生成的文档会包含以下信息:

  • 类说明:类的描述、构造方法、方法等。

  • 方法说明:每个方法的参数、返回值、功能描述。

  • 导航栏:方便查看类、方法、字段等。

[重点]为什么注释写了不影响程序运行呢?

源代码——>编译——>字节码文件(其中没有注释的内容)——>虚拟机运行

其实在编译的时候,编译器不会编译注释,生成的字节码文件中没有注释存在,固然就不影响了。

解释举例:

我们看在out文件夹中,打开字节码文件,看不懂。

利用IDEA进行反编译,让字节码文件变为我们能看懂的形式。

这个就是IDEA反编译的字节码文件的结果,我们可以看到不存在注释。

[重点]注释快捷键:

Ctrl + shift + / 多行选中,进行多行注释

Ctrl + / 单行注释

回顾

1.什么是注释?

注释是对程序解释说明的文字。

2.为什么写注释不会影响程序的运行?

字面量

数据在程序中的书写格式。

1.字符

单引号,有且只有一个字符

\n、\t

2.字符串

3.布尔

4.null

双引号,内容没有要求

1.字面量这个知识是告诉同学们什么?

  • 数据在程序中的书写格式。

2.字符、字符串在程序中的书写格式有什么要求?

  • 字符必须单引号围起来,有且仅能一个字符。

  • 字符串必须用双引号围起来。

3.几个常见的特殊值的书写格式是?

  • true、false、nul、\n、\t

练习:

/**
 *文档注释
 *
 */
public class Main {
    public static void main(String[] args) {
        //System.out.println("Hello World");
        System.out.println('a');
        /*
        System.out.println("啦啦啦");
        System.out.println(" ");
        System.out.println("123\n");
        */
        System.out.println("-------------");
        System.out.println("12\n3");
        System.out.println(false);
        System.out.println(true);
        System.out.println('\n');
        System.out.println("\t213");//tab键
​
    }
}

一、变量

内存中的一块区域,用来存储一个数据的

int age = 18;

在内存中开辟一块空间age用于存储18。

为什么要使用变量?

用来存储数据,让数据存储更方便。

变量的特点?

变量中的数据是可以被替换,可以赋值

public class Main2 {
    public static void main(String[] args) {
        int a = 18;
        a =a + 1;
        System.out.println(a);
    }
}

回顾

1.变量是什么?变量的完整定义格式是什么?

  • 内存中的一块区域,用来存储一个数据的

  • 数据类型 变量名称 = 数据;

2.变量的特点?

3.应用场景?

记住处理的数据的时候。


[重点]注意事项:

1.使用的时候必须先声明,再使用。

2.什么类型的变量,只能存储什么样的类型的数据

[重点]3.变量的有效范围从定义开始到”}“截止,同一个范围内不能定义两个同名变量。

4.变量定义的时候可以没有初始值,但是使用的时候必须进行初始化。

初始化= 定义变量+变量赋值。

public class Main2 {
    public static void main(String[] args) {
        int a = 12;
        System.out.println(a);
//        int a = 13;//1.同一个范围内不能定义两个同名变量
 //       int d =5.0;//2.什么类型的变量,只能存储什么样的类型的数据
        {
            int b;
            b = 10;
            System.out.println(a);//3.[重点]变量的有效范围从定义开始到”}“截止
            //[重点]内部代码块可以访问外部的代码块的内容,所以这里是可以打印a变量的。
            System.out.println(b);
        }
      /*  int c;
        System.out.println(c);//4.变量使用时必须进行初始化,否则报错
        */
​
    }
}

[重点]这里强调一下代码块{}的作用:
  • 规则 1:变量的作用域从定义的位置开始,到其所在的代码块结束(即最近的 })。

  • [重点]规则 2内部代码块可以访问外部代码块的变量,但外部代码块不能访问内部代码块的变量。

  • 规则 3:同一作用域内不能定义同名变量。

[重点]**另一种理解:其实是int a = 12;是在外部的代码块中,虽然输出a语句在内部代码块,但是在int a = 12;属外部的代码块,在外部的代码块之内,随意访问a变量是都可以的。

用代码块的规则2也可以解释。


二、关键字,标识符

关键字

关键字(全部是小写):public 等等

[重点]在IDEA中是高亮显示的都是关键字

特殊:main不是关键字

注意:Java的关键字不能作为:类名、变量名

标识符

标识符就是名字,我们在写程序时,会起一些名字,如类名、变量名等等都是标识符。

标识符的要求规范

  • 基本组成:数字、字母、下划线_和美元符号$等组成。

  • 强制要求:不能以数字开头、不能用关键字作为名字、且是区分大小写的。

    • 汉字可以作为变量名了,但是不建议用。

[重点]区分 大小写导致的与关键字相似
class 不行,因为是关键字
Class 可以,因为区分大小写,这里不是关键字
_2b 可以
2b 不行,不能以数字开头
$2 可以
[重点]标识符的建议规范

变量名称建议:满足标识符规则,同时用英文、有意义、首字母小写,"驼峰命名"(小驼峰命名)helloWorld

名称建议:满足标识符规则,同时用英文、有意义、首字母大写,"驼峰命名"。HelloWorld

回顾:

什么是关键字?

  • java程序要用到词,并且具有特殊含义的词。

  • 不能作为”类、变量名,否做报错

什么是标识符?要满足什么规范?

  • 就是名字

  • 规范:

    • 变量名称建议:

    • 类名称建议:


[较重点]变量在计算机底层的存储

进制转换。

十——>二:除二取余法

计算机中的数据的最小单位:字节byte,简称B。

二进制的一位是1个比特bit,简称b。

1字节 = 8bit

1.数据在计算机底层是如何存储的?

2.如何快速算出一个数字的二进制形式?

3.数据在计算机底层存储数据的最小单位是什么?

  • 字节byte 简称B

  • 1字节 = 8比特,简称b


文本在计算机如何存储的?

1.字符(文本)在计算机中是如何存储的?

ASCII编码表,美国信息交换标准编码,规定了现代英语、数字字符、和其他西欧字符对应的数字编号。

2.图片

一个像素点
0~255*255*255的颜色值来表示。
就这样表示了

3.音频、

  1. 采样:将连续声波离散化为样本点。模拟信号——>离散信号——>计算机

  2. 量化:将振幅值转换为数字。

  3. 编码:存储为二进制数据(可选择压缩mp3等)。

  4. 格式封装:添加元数据,生成音频文件(如 WAV、MP3)。


http://www.kler.cn/a/566949.html

相关文章:

  • 企业级本地知识库部署指南(Windows优化版)
  • 什么是 Prompt?——一篇详细的介绍
  • FloodFill 算法(典型算法思想)—— OJ例题算法解析思路
  • Win 11 C盘相邻的分区是恢复分区导致无法扩容
  • PDF文件转换为PNG图像
  • DH法建立6自由度机械臂正运动学模型
  • 数据库设计报告
  • 介绍一款飞算JavaAI编程工具,集成到idea,图文并茂
  • Graph Convolutional Networks(GCN)图卷积网络
  • 解释 Node.js 中的异步编程模型,如何使用回调、Promise 和async / await 处理异步操作?
  • PyCharm Python 环境配置指南
  • HTTP3.0 和 HTTP2.0,HTTP1.0区别
  • 前端存储方案全面对比:localStorage、sessionStorage、cookies与IndexedDB
  • 【 开发知识点 一 】 随机数生成器 /dev/urandom 和 /dev/random
  • 第一届启航杯-web-misc(全)
  • 如何查看react的版本号
  • 如何长期保存数据(不包括云存储)最安全有效?
  • 决策树:机器学习中的分类与回归利器
  • LabVIEW 无法播放 AVI 视频的编解码器解决方案
  • Unclutter for Mac v2.2.12 剪贴板/文件暂存/笔记三合一 支持M、Intel芯片