编程中的注释分为三类单行注释，多行注释，文档注释；

Posted 2023-05-06

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了编程中的注释分为三类单行注释，多行注释，文档注释；相关的知识，希望对你有一定的参考价值。

RT+前两个照字面就知道什么意思，至于文档注释是什么意思?

由于是业余学习，问题很简单~~

通俗一点的解释

谢谢~~~

晕~~~ 自己还是找到了 ·· 留给后来人吧···

http://www.diybl.com/course/3_program/java/javajs/2008911/141971.html

java文档注释（有示例）

Java代码规范--注释

@author LEI

@version 1.10 2005-09-01

1 注释文档的格式注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。

例如：

/**

* The doGet method of the servlet.

* This method is called when a form has its tag value method equals to get.

*

* @param request

* the request send by the client to the server

* @param response

* the response send by the server to the client

* @throws ServletException

* if an error occurred

* @throws IOException

* if an error occurred

*/

public void doGet (HttpServletRequest request, HttpServletResponse response)

throws ServletException, IOException

doPost(request, response);

前两行为描述，描述完毕后，由@符号起头为块标记注视。

2 注释的种类2.1 文件头注释
文件头注释以 /*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。

例如：

/*

* Created on 2005-7-2

* /

2.2 类、接口注释
类、接口的注释采用 /** … */，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。

例如：

/**Title: XXXX DRIVER 3.0
*Description: XXXX DRIVER 3.0
*Copyright: Copyright (c) 2003
*Company:XXXX有限公司
*
* @author Java Development Group
* @version 3.0
*/

例如：

/**
* A class representing a window on the screen.
* For example:
*
* Window win = new Window(parent);
* win.show();
*
*
* @author Sami Shaio
* @version %I%, %G%
* @see java.awt.BaseWindow
* @see java.awt.Button
*/

class Window extends BaseWindow

...

2.3 构造函数注释
构造函数注释采用 /** … */，描述部分注明构造函数的作用，不一定有块标记部分。

例如：

/**

* 默认构造函数

*/

有例如：

/**

* 带参数构造函数,初始化模式名,名称和数据源类型

*

* @param schema

* Ref 模式名

* @param name

* Ref 名称

* @param type

* byVal 数据源类型

*/

2.4 域注释
域注释可以出现在注释文档里面，也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面，而使用/* … */的注释会被忽略。

例如：

/* 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */

boolean isTrigerSuccess = false;

又例如：

/** 由于triger和表用一个DMSource，所以要区分和表的迁移成功标记 */

boolean isTrigerSuccess = false;

再例如：

/**

* The X-coordinate of the component.

*

* @see #getLocation()

*/

int x = 1263732;

2.5 方法注释
方法注释采用 /** … */，描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息。例如：

/**

* 设置是否有外码约束

*

* @param conn

* Connection 与数据库的连接

*/

2.6 定义注释
规则同域注释。

3 注释块标记3.1 标记的顺序
块标记将采用如下顺序：

…

*

* @param (classes, interfaces, methods and constructors only)

* @return (methods only)

* @exception (@throws is a synonym added in Javadoc 1.2)

* @author (classes and interfaces only, required)

* @version (classes and interfaces only, required. See footnote 1)

* @see

* @since

* @serial (or @serialField or @serialData)

* @deprecated (see How and When To Deprecate APIs)

* …

一个块标记可以根据需要重复出现多次，多次出现的标记按照如下顺序：

@author 按照时间先后顺序（chronological）

@param 按照参数定义顺序（declaration）

@throws 按照异常名字的字母顺序（alphabetically）

@see 按照如下顺序：

@see #field

@see #Constructor(Type, Type...)

@see #Constructor(Type id, Type id...)

@see #method(Type, Type,...)

@see #method(Type id, Type, id...)

@see Class

@see Class#field

@see Class#Constructor(Type, Type...)

@see Class#Constructor(Type id, Type id)

@see Class#method(Type, Type,...)

@see Class#method(Type id, Type id,...)

@see package.Class

@see package.Class#field

@see package.Class#Constructor(Type, Type...)

@see package.Class#Constructor(Type id, Type id)

@see package.Class#method(Type, Type,...)

@see package.Class#method(Type id, Type, id)

@see package

3.2 标记介绍
3.2.1 @param标记
@param后面空格后跟着参数的变量名字（不是类型），空格后跟着对该参数的描述。

在描述中第一个名字为该变量的数据类型，表示数据类型的名次前面可以有一个冠词如：a,an,the。如果是int类型的参数则不需要注明数据类型。例如：

…

* @param ch the char 用用来……

* @param _image the image 用来……

* @param _num 一个数字……

…

对于参数的描述如果只是一短语，最好不要首字母大写，结尾也不要句号。

对于参数的描述是一个句子，最好不要首字母大写，如果出现了句号这说明你的描述不止一句话。如果非要首字母大写的话，必须用句号来结束句子。（英文的句号）

公司内部添加ByRef和ByVal两个标记，例如：

* @param _image the image ByRef 用来……

说明该参数是引用传递（指针），ByVal可以省略，表示是值传递。

3.2.2 @return标记
返回为空（void）的构造函数或者函数，@return可以省略。

如果返回值就是输入参数，必须用与输入参数的@param相同的描述信息。

必要的时候注明特殊条件写的返回值。

3.2.3 @throws 标记
@throws以前使用的是@exception。

@throws的内容必须在函数的throws部分定义。

3.2.4 @author标记
类注释标记。

函数注释里面可以不出现@author。

3.2.5 @version
类注释标记。

文章出处：http://www.diybl.com/course/3_program/java/javajs/2008911/141971.html

参考资料：http://www.diybl.com/course/3_program/java/javajs/2008911/141971.html

参考技术A 文档注释是用工具能提取出来做为文档的注释
如java中用/**
*/
的是文档注释

C#中则用
///
开始的是文档注释本回答被提问者采纳

day02-Java基础语法

day02 - Java 基础语法

1. 注释

注释是对代码的解释和说明文字。

Java 中的注释分为三种：

单行注释：

// 这是单行注释文字

多行注释：

/*
这是多行注释文字
这是多行注释文字
这是多行注释文字
*/
注意：多行注释不能嵌套使用。

文档注释（暂时用不到）：

/**
这是多行注释文字
这是多行注释文字
这是多行注释文字
*/

使用的技巧

如果我们要对代码进行解释，那么就可以使用注释。

当注释的内容比较少，一行就写完了，可以用单行注释。

如果注释的内容比较多，需要写在多行，那么可以使用多行注释。

注意点

注释的内容不会参与编译和运行的，仅仅是对代码的解释说明而已。

所以，不管在注释当中写什么内容，都不会影响代码运行的结果。

2. 关键字

2.1 概念

被 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

2.2 第一个关键字 class

表示定义一个类。创建一个类。

类：Java 项目最基本的组成单元，一个完整的 Java 项目有可能会有成千上万个类来组成的。

class 后面跟随的就是这个类的名字，简称：类名。

在类名后面会有一对大括号，表示这个类的内容。

举例：

public class HelloWorld

解释：class 表示定义类。

类名：HelloWorld

HelloWorld 后面的大括号表示这个类的范围。

3. 字面量

作用：告诉程序员，数据在程序中的书写格式。

字面量类型	说明	程序中的写法
整数	不带小数的数字	666，-88
小数	带小数的数字	13.14，-5.21
字符	必须使用单引号，有且仅能一个字符	‘A’，‘0’， ‘我’
字符串	必须使用双引号，内容可有可无	“HelloWorld”，“黑马程序员”
布尔值	布尔值，表示真假，只有两个值：true，false	true 、false
空值	一个特殊的值，空值	值是：null

public class Demo 
    public static void main(String[] args) 
        System.out.println(10); // 输出一个整数
        System.out.println(5.5); // 输出一个小数
        System.out.println(\'a\'); // 输出一个字符
        System.out.println(true); // 输出boolean值true
        System.out.println("欢迎来到黑马程序员"); // 输出字符串

区分技巧

不带小数点的数字都是整数类型的字面量。
只要带了小数点，那么就是小数类型的字面量。
只要用双引号引起来的，不管里面的内容是什么，不管里面有没有内容，都是字符串类型的字面量。
字符类型的字面量必须用单引号引起来，不管内容是什么，但是个数有且只能有一个。
字符类型的字面量只有两个值，true、false。
空类型的字面量只有一个值，null。

4. 变量

4.1 什么是变量？

变量就在程序中临时存储数据的容器。但是这个容器中只能存一个值。

4.2 变量的定义格式

数据类型变量名 = 数据值；

4.2.1 格式详解

数据类型：限定了变量当中能存储什么类型的数据。

如果要存 10，那么数据类型就需要写整数类型。

如果要存 10.0，那么数据类型就需要写小数类型。

变量名：其实就是这个容器的名字。

当以后想要使用变量里面的数据时，直接使用变量名就可以了。

数据值：真正存储在容器中的数据。

分号：表示语句的结束，就跟以前写作文时候的句号是一样的。

4.2.2 常用的数据类型

整数：int

小数：（浮点数）double

其他数据类型稍后讲解

举例：

public class VariableDemo
	public static void main(String[] args)
		//定义一个整数类型的变量
		//数据类型 变量名 = 数据值;
		int a = 16;
		System.out.println(a);//16

		//定义一个小数类型的变量
		double b = 10.1;
		System.out.println(b);//10.1

4.2.3 变量的注意事项

变量名不能重复
在一条语句中，可以定义多个变量。但是这种方式影响代码的阅读，所以了解一下即可。
变量在使用之前必须要赋值。

案例：

public class VariableDemo2
	public static void main(String[] args)
		//1.变量名不允许重复
		//int a = 10;
		//int a = 20;
		//System.out.println(a);

		//2.一条语句可以定义多个变量
		//了解。
		//int a = 10, b = 20, c = 20,d = 20;
		//System.out.println(a);//?
		//System.out.println(b);//?


		//3.变量在使用之前必须要赋值
		int a = 30;
		System.out.println(a);

4.3 变量的练习

需求：说出公交车到终点站之后，车上一共有多少乘客？

一开始没有乘客。

第一站：上去一位乘客，没有下来乘客。

第二站：上去两位乘客，下来一位乘客。

第三站：上去两位乘客，下来一位乘客。

第四站：没有上去乘客，下来一位乘客。

第五站：上去一位乘客，没有下来乘客。

问：到了终点站之后，车上一共多少乘客？

代码解析：

public class VariableTest1
	//主入口
	public static void main(String[] args)
		//一开始没有乘客。
		int count = 0;
		//第一站：上去一位乘客
		//在原有的基础上 + 1
		count = count + 1;
		//System.out.println(count);
		//第二站：上去两位乘客，下来一位乘客
		count = count + 2 - 1;
		//第三站：上去两位乘客，下来一位乘客
		count = count + 2 - 1;
		//第四站：下来一位乘客
		count = count - 1;
		//第五站：上去一位乘客
		count = count + 1;
		//请问：到了终点站，车上一共几位乘客。
		System.out.println(count);//3

5. 数据类型

5.1 Java 语言数据类型的分类

基本数据类型
引用数据类型（面向对象的时候再深入学习）

5.2 基本数据类型的四类八种

数据类型	关键字	内存占用	取值范围
整数	byte	1	负的 2 的 7 次方 ~ 2 的 7 次方-1(-128~127)
	short	2	负的 2 的 15 次方 ~ 2 的 15 次方-1(-32768~32767)
	int	4	负的 2 的 31 次方 ~ 2 的 31 次方-1
	long	8	负的 2 的 63 次方 ~ 2 的 63 次方-1
浮点数	float	4	1.401298e-45 ~ 3.402823e+38
	double	8	4.9000000e-324 ~ 1.797693e+308
字符	char	2	0-65535
布尔	boolean	1	true，false

说明

e+38 表示是乘以 10 的 38 次方，同样，e-45 表示乘以 10 的负 45 次方。

在 java 中整数默认是 int 类型，浮点数默认是 double 类型。

需要记忆以下几点

byte 类型的取值范围：

-128 ~ 127

int 类型的大概取值范围：

-21 亿多 ~ 21 亿多

整数类型和小数类型的取值范围大小关系：

double > float > long > int > short > byte

最为常用的数据类型选择：

在定义变量的时候，要根据实际的情况来选择不同类型的变量。

比如：人的年龄，可以选择 byte 类型。

比如：地球的年龄，可以选择 long 类型。
如果整数类型中，不太确定范围，那么默认使用 int 类型。
如果小数类型中，不太确定范围，那么默认使用 double 类型。
如果要定义字符类型的变量，那么使用 char
如果要定义布尔类型的变量，那么使用 boolean

5.3 定义 8 种基本数据类型变量

public class VariableDemo3
    public static void main(String[] args)
        //1.定义byte类型的变量
        //数据类型 变量名 = 数据值;
        byte a = 10;
        System.out.println(a);

        //2.定义short类型的变量
        short b = 20;
        System.out.println(b);

        //3.定义int类型的变量
        int c = 30;
        System.out.println(c);

        //4.定义long类型的变量
        long d = 123456789123456789L;
        System.out.println(d);

        //5.定义float类型的变量
        float e = 10.1F;
        System.out.println(e);

        //6.定义double类型的变量
        double f = 20.3;
        System.out.println(f);

        //7.定义char类型的变量
        char g = \'a\';
        System.out.println(g);

        //8.定义boolean类型的变量
        boolean h = true;
        System.out.println(h);

注意点

如果要定义一个整数类型的变量，不知道选择哪种数据类型了，默认使用 int。
如果要定义一个小数类型的变量，不知道选择哪种数据类型了，默认使用 double。
如果要定义一个 long 类型的变量，那么在数据值的后面需要加上 L 后缀。（大小写都可以，建议大写。）
如果要定义一个 float 类型的变量，那么在数据值的后面需要加上 F 后缀。（大小写都可以）

5.4 练习 1

需求：定义 5 个变量记录老师的信息并打印

代码示例：

public class VariableTest1
	public static void main(String[] args)
		//1.定义字符串类型的变量记录老师的姓名
		String name = "黑马谢广坤";
		//2.定义整数类型的变量记录老师的年龄
		int age = 18;
		//3.定义字符类型的变量记录老师的性别
		char gender = \'男\';
		//4.定义小数类型的变量记录老师的身高
		double height = 180.1;
		//5.定义布尔类型的变量记录老师的婚姻状况
		boolean flag = true;

		//输出5个变量的值
		System.out.println(name);
		System.out.println(age);
		System.out.println(gender);
		System.out.println(height);
		System.out.println(flag);

5.5 练习 2

需求：将（电影名称，主演，年份，评分）四个信息选择不同类型的变量，随后打印出来。

代码示例：

public class VariableTest2
	public static void main(String[] args)
		//1.定义字符串变量记录电影的名称
		String movie = "送初恋回家";
		//2.定义三个变量记录主演的名字
		String name1 = "刘鑫";
		String name2 = "张雨提";
		String name3 = "高媛";
		//3. 定义整数类型的变量记录年龄的年份
		int year = 2020;
		//4.定义小数类型的变量记录电影的评分
		double score = 9.0;

		//打印变量的信息
		System.out.println(movie);
		System.out.println(name1);
		System.out.println(name2);
		System.out.println(name3);
		System.out.println(year);
		System.out.println(score);

5.6 练习 3

需求：选择其中一部手机，将（手机价格，手机品牌）两个信息选择不同类型的变量，随后打印出来。

代码示例：

public class VariableTest3
	public static void main(String[] args)
		//1.定义小数类型的变量记录手机的价格
		double price = 5299.0;

		//2.定义字符串类型的变量记录手机的品牌
		String brand = "华为";

		//输出变量记录的值
		System.out.println(price);
		System.out.println(brand);

6. 标识符

业内大多数程序员都在遵守阿里巴巴的命名规则。

在 day02 的资料文件夹中有。

6.1 硬性要求：

必须要这么做，否则代码会报错。

必须由数字、字母、下划线_、美元符号$组成。
数字不能开头
不能是关键字
区分大小写的。

6.2 软件建议：

如果不这么做，代码不会报错，但是会让代码显得比较 low。

6.2.1 小驼峰命名法

适用于变量名和方法名

如果是一个单词，那么全部小写，比如：name
如果是多个单词，那么从第二个单词开始，首字母大写，比如：firstName、maxAge

6.2.2 大驼峰命名法

适用于类名

如果是一个单词，那么首字母大写。比如：Demo、Test。
如果是多个单词，那么每一个单词首字母都需要大写。比如：HelloWorld

不管起什么名字，都要做到见名知意。

阿里巴巴命名规范细节：

尽量不要用拼音。但是一些国际通用的拼音可视为英文单词。

正确：alibaba、hangzhou、nanjing

错误：jiage、dazhe
平时在给变量名、方法名、类名起名字的时候，不要使用下划线或美元符号。

错误：_name

正确：name

7. 键盘录入

键盘录入的实际功能 Java 已经帮我们写好了，不需要我们自己再实现了，而 Java 写好的功能都放在了 Scanner 这个类中，所以，我们只要直接使用 Scanner 这个类就可以了。

使用步骤：

第一步：

导包：其实就是表示先找到 Scanner 这个类在哪。

第二步：

创建对象：其实就表示申明一下，我准备开始用 Scanner 这个类了。

第三步：

接收数据：也是真正干活的代码。

代码示例：

//导包，其实就是先找到Scanner这个类在哪
import java.util.Scanner;
public class ScannerDemo1
	public static void main(String[] args)
		//2.创建对象，其实就是申明一下，我准备开始用Scanner这个类了。
		Scanner sc = new Scanner(System.in);
		//3.接收数据
		//当程序运行之后，我们在键盘输入的数据就会被变量i给接收了
		System.out.println("请输入一个数字");
		int i = sc.nextInt();
		System.out.println(i);