Java中的注释关键字标识符

最新推荐文章于 2023-04-18 18:23:56 发布

liaoYu1887

最新推荐文章于 2023-04-18 18:23:56 发布

阅读量339

点赞数

分类专栏： Java 文章标签： Java注释 Java关键字 Java标识符

本文链接：https://blog.csdn.net/liaoYu1887/article/details/84937020

版权

Java 专栏收录该内容

7 篇文章 0 订阅

订阅专栏

内容部分引自：https://www.cnblogs.com/liusxg/p/5277068.html
https://blog.csdn.net/shiyuezhong/article/details/8205281

一、注释

1、基本规则
（1）应使代码更加清晰易懂
（2）简洁明了，能让阅读者明确理解程序必要信息就好
（3）基本注释（必须加）：类、接口、构造函数、方法、全局变量和属性，其中属性可添加简单注释
（4）特殊必加注释（必须加）：代码不明晰处、代码修改处、典型算法处、循环和逻辑分支组成的代码处和为他人提供的接口处
（5）简单注释一般不超过10个字

2、Java注释的三种方式
（1）单行注释：简单注释，用来描述某个变量、属性或程序块
格式：//注释内容
（2）块注释：进行多行简单注释，一般不使用
格式：/*注释内容*/
（3）文档注释：对类、接口、成员变量、静态字段、静态方法、常量进行说明。Javadoc可以用它产生代码的文档
格式：/**注释内容*/
（4）javadoc常用注释标签语法
@author 对类的说明，标明开发该类模块的作者
@version 对类的说明，标明该类模块的版本
@see 对类、属性、方法的说明，标明参考转向，也就是相关主题
@param 对方法的说明，对方法中某参数的说明
@return 对方法的说明，对方法返回值的说明
@exception 对方法的说明，对方法可能抛出的异常进行说明

3、实例展示
（1）类（接口）注释

/**
 * 此类是一个学生类
 * @author ly
 * @version 1.0
 * @see xxx
 * @Time 2018年12月4日下午3:09:17
 */
public class Student {
    ...
}

（2）构造方法注释

/**
  * 这是Student的构造方法
  * @param name
  */
public Student(String name){
	...
}

（3）方法注释

/**
  *删除一条学生信息
  *@param id 学生id
  *@return 返回一个int类型值
  *@exception (方法有异常时加)
  *@author ly
  *@Time 2018年12月4日下午3:09:17
  */
public int selStudent(int id){
	...
}

（4）全局变量注释

public class Student {
	/** count是所有学生的数量  */
	private final int count=0;
}

（5）字段注释

private int id;//学生id
private String name;//学生姓名
private double salary;//薪资

二、关键字

Java关键字，也叫保留字，是Java语言中事先定义的，有特别意义的标识符，常用来表示一种数据类型，或者表示程序的结构等，关键字不能作为变量名、方法名、类名、包名和参数。
常见关键字：

abstract、assert、boolean、break、byte、case、catch、char、class、const、continue、default、do、double、else、enum、extends、final、finally、float、for、goto、if、implements、import、instanceof、int、interface、long、native、new、package、private、protected、public、return、strictfp、short、static、super、switch、synchronized、this、throw、throws、transient、try、void、volatile、while