91年入苏联系列——Java入门02

90 阅读3分钟

基础语法

一、注释

Java中的注释是代码中用于解释逻辑、功能或提供文档的关键工具,主要分为以下三类,每种注释在语法、用途和规范上存在差异:


  1. 单行注释(Single-line Comments)
  • 语法:以 // 开头,后续内容至行尾均为注释。
  • 用途:
    • 解释单行代码的功能或快速注释掉某行代码。
    • 适用于行尾的简短说明,例如:int x = 5; // 定义变量x
  • 示例:
    // 这是一个单行注释
    System.out.println("Hello World");
    

  1. 多行注释(Multi-line Comments)
  • 语法:以 /* 开始,*/ 结束,可跨越多行。
  • 用途:
    • 解释代码块的功能或较长的逻辑说明。
    • 适合描述算法实现细节或团队协作中的沟通信息。
  • 注意事项:
    • 不可嵌套多行注释,否则会导致编译错误。
    • 可嵌套单行注释,例如:
    /*
    • 这是一个多行注释
    • // 嵌套的单行注释 */

  1. 文档注释(Documentation Comments)
  • 语法:以 / 开头,*/ 结束,通常包含 @ 标签。
  • 用途:
    • 生成API文档,通过 javadoc 工具提取内容生成HTML格式的帮助文档。
    • 描述类、方法、字段的功能、参数、返回值及异常。
  • 常用标签:
    • @param:方法参数说明。
    • @return:返回值说明。
    • @author:作者信息。
    • @throws:抛出的异常类型。
  • 示例:
    /
     * 计算两数之和
     * @param a 第一个整数
     * @param b 第二个整数
     * @return 两数之和
     * @throws IllegalArgumentException 参数为负数时抛出
     */
    public int add(int a, int b) {
        if (a < 0 || b < 0) throw new IllegalArgumentException();
        return a + b;
    }
    

注释的最佳实践

  1. 位置规范:
    • 类、接口、方法、常量等声明前需添加注释。
    • 关键算法或复杂逻辑处需详细说明。
  2. 内容原则:
    • 简洁准确:避免冗长或模糊描述。
    • 统一形式:全项目保持一致的注释风格。
  3. 工具使用:
    • 使用IDE(如IntelliJ IDEA)自动生成文档注释。
    • 通过命令行生成API文档:javadoc -d output_dir *.java

注意事项

  • 不可嵌套:多行注释和文档注释均不可自嵌套,否则会导致编译错误。
  • 私有元素注释:默认情况下,javadoc 仅提取 publicprotected 修饰的元素注释,需通过 -private 参数包含私有内容。 通过合理使用注释,可以显著提升代码的可读性和可维护性,尤其在团队协作和大型项目中至关重要。

二、基于数据的字面量和变量

(一)敲代码就是敲数据。

你能够直接敲出来并且敲出来就能用的,叫字面量。它们形态各样。数据敲出来之后,要给它们起个名字,以便调用它们,这个名字就是变量。 你可以发现: 字面量的分类有小数、整数、布尔值、字符、字符串、空值。

变量有类型吗?--答案是没有!你想叫它啥名字都可以,但是为不出现自己看不懂自己敲的代码的情况,现在要求以小驼峰命名法去对变量进行命名。

变量所对应的数据是固定的吗?--不是!

变量的注意事项:

1.变量要先声明才能使用

2.变量要使用正确的数据类型

3.变量在定义的{}中有效

4.变量在同一个范围内不能重名

5.变量在定义时可以不赋值, 但是在使用前必须保证有值

(二)字面量的类型就是数据的类型

数据的类型

1.基本数据类型

1.1整型

byte:-128 ~ 127

short:-32768 ~ 322767

int:-2147483648 ~ 2147483647(整数默认是int)

long:19位(后面要加l/L)

1.2浮点型

float:后面要加f/F

double:小数默认是double

1.3字符型:char

1.4布尔型:boolean

true

false

3. 引用数据类型--后面再聊