Java文档注释标识符 关键字

Java 注释功能的强大

单行注释 多行注释

public class Test {
    public static void main(String[] args) {
        // 这里是单行注释
        int a = 10;
        /*
        这里是多行注释
        这里是多行注释
         */
        int b = 6;
    }
}

文档注释

你不是说Java 注释功能很强吗？就一个简单的注释，有什么强大的？
接下来看我操作。

/**
* 这是文档注释
* 这是文档注释
*/

• 1.代码写好注释

import java.util.Arrays;

/**
 * 这是一个快速排序模板
 * version 1.0
 * author zxh
 *
 */
public class Test {
    /**
     *  N 数组大小
     */
    static int N = 20;
    static int[] arr;

    public static void main(String[] args) {
        // TODO Auto-generated method stub

        arr = new int[] {1,5,3,7,4,2,5,9,7};
        fast(arr,0,arr.length-1);
        System.out.print(Arrays.toString(arr));
    }

    /**
     *
     * @param arr 被排序的数组
     * @param l 开始位置
     * @param r 结束位置
     */
    private static void fast(int[] arr,int l, int r) {
        // TODO Auto-generated method stub
        if(l>=r) return ;
        int m = arr[l];
        int i = l-1;
        int j = r+1;
        while(i<j) {

            do {
                i++;
            }while(arr[i]<m);

            do {
                j--;
            }while(arr[j]>m);

            if(i<j) {
                int tmp = arr[i];
                arr[i] = arr[j];
                arr[j] = tmp;
            }
        }
        fast(arr,l,j);fast(arr,j+1,r);

    }

}

• 2.到文件所在位置，打开cmd 窗口Javac 文件名.java
• 注意如果报错为 错误: 编码GBK的不可映射字符
  
• 那就加上 -encoding utf-8 javac -encoding utf-8 Test.java 指定源代码文件的字符编码为 UTF-8
  
• 3 javadoc 是 Java 提供的一个工具，用于从 Java 源代码中抽取类、方法、字段等的注释，并生成 HTML 格式的 API 文档。
  
• 4
  
• 5
  
• 6 自己写的API文档
  

注释规范

内容要准确 ,修改后及时更新
篇幅合理,不要过多，简洁明了
积极向上，不能写（如：领导SB）

标识符

标识符：在程序中由用户给类名，方法名，变量名所取的名字。
标识符只能由 数字，字母，下划线 _ ，美元符号 $ 组成。且不能以数字开头（如：123test）。
建议：
类名： 大驼峰 每个首字母大写如 TestClass
方法名，变量名：小驼峰 第一个首字母小写，后面的首字母大写。如：testFunction

关键字

再写码代码时，不同的词会出现不同的颜色。
像上面橙色的字就是关键字。
关键字是由Java语言提前定义好的，有特殊的含义。

注意 main 不是关键字，但一般也不会用到做变量名… 。

• 访问修饰符

  • private 私有类，只允许自己可以访问，外面访问不到
  • protected 受保护的，同包，不同包的子类可以访问
  • public 可以任何地方访问

• 类型声明

  • class 声明一个类
  • interface 声明一个接口

• 类型修饰符

  • abstract 声明一个抽象类
  • final 表明一个类不能被继承，一个方法不能被重写，或者一个变量是一个常量
  • static：表明一个成员变量或方法属于类本身，而不是类的实例。

• 流程控制

  • if：用于条件判断。
  • else：与if一起使用，表示不满足条件时的操作。
  • switch：用于多分支选择。
  • case：与switch一起使用，表示一个分支。
  • default：在switch语句中，当没有case匹配时执行。
  • while：用于循环执行一段代码，直到条件不满足。
  • do：与while一起使用，形成至少执行一次的循环。
  • for：用于循环执行一段代码固定次数。
  • break：跳出当前循环或switch语句。
  • continue：跳过当前循环的剩余部分，进入下一次循环。
  • return：从方法中返回一个值，并结束方法执行

• 错误处理

  • try：用于包含可能抛出异常的代码块。
  • catch：用于捕获并处理异常
  • finally：无论是否发生异常，都会执行的代码块
  • throw：显式地抛出一个异常
  • throws：在方法签名中声明该方法可能抛出的异常

• 其他关键字

• assert：用于调试，可以检查一个条件是否为真，如果不为真则抛出AssertionError
• instanceof：用于测试一个对象是否是指定类型的实例。
• new：用于创建对象实例。
• this：引用当前对象实例。
• super：引用父类实例。
• import：用于导入类或包。
• native：声明一个方法是用非Java语言实现的。
• synchronized：用于确保同一时间只有一个线程可以执行某段代码。
• transient：标记一个字段不应被序列化。
• volatile：确保多个线程之间对某个变量的访问是同步的。