【Java基础学习打卡14】Java注释

编程火箭车

已于 2023-07-21 11:03:18 修改

阅读量294

点赞数 3

分类专栏：《JavaSE基础学习打卡-小白入门》文章标签： java Java注释单行注释多行注释文档注释 javadoc 注释的重要性

于 2023-07-07 15:01:23 首次发布

本文链接：https://blog.csdn.net/Li_Ya_Fei/article/details/131594332

版权

《JavaSE基础学习打卡-小白入门》专栏收录该内容

21 篇文章 1 订阅

订阅专栏

前言

本文介绍Java注释，它是我们在Java编程中必不可少的。Java注释有单行注释、多行注释和文档注释。对于初学者，千万不要忙着敲代码，而忽视注释。

一、什么是注释

注释（汉语词语）： 注释是指解释子句的文字，也指用文字解释字句。

在这里插入图片描述
假设你正在计划一次旅行。你会收集各种关于目的地的旅行指南、地图和建议。旅行指南上的注释就好比你的旅行计划中的注释。

在这里插入图片描述
在旅行指南上，你会发现一些附加的信息和提示。比如，景点介绍、历史背景、推荐的行程安排、交通指南等。这些信息并不是必须的，但它们提供了额外的解释和指导，让你更好地了解和计划你的旅行。

同样地，在编程中，注释也是提供额外解释和指导的。 它们用于向代码中添加解释、说明和提示，帮助你和其他开发者更好地理解代码。

二、注释的重要性

程序员最讨厌的两件事：别人不写注释和自己要写注释！（程序员的心声）

在这里插入图片描述

程序员最讨厌的这两件事也说明了程序注释的重要性和必要性。接下来就来谈谈为什么要添加程序注释，这里考虑以下几个方面进行说明：

提高代码可读性： 帮助自己或他人更快地理解代码的意图和实现方式。
方便代码维护和修改： 帮助开发人员更快地理解代码的结构和功能，减少维护和修改过程中的困惑和错误。
促进团队协作： 团队开发中，注释起到了文档的作用。减少沟通成本，提高工作效率。
加深自己对代码的理解： 编写注释是一种对代码进行深入理解和思考的过程。帮助自己对代码的理解更加准确和全面。

我们要在日常的编程学习中养成编写注释的习惯，以提高编程能力和团队合作能力。其实几乎所有的编程语言有提供了添加注释的方法，Java语言也不例外，Java语言提供了三种注释：

单行注释
多行注释
文档注释

三、单行、多行注释

1.单行注释

单行注释（Single-line comments）：以双斜线（ // ）开头，用于注释一行代码或说明代码的作用。 单行注释会被编译器忽略，不会被执行。

// 单行注释，以下代码向控制台输出一句话
System.out.println("Hello World!");
// System.out.println("这行代码注释掉了，不会被执行!");

2.多行注释

多行注释（Multi-line comments）：以斜线星号（ /* ）开头和星号斜线（ */ ）结尾，用于注释多行代码或详细说明代码的功能。 多行注释会被编译器忽略，不会被执行。

/*
 * 多行注释
 * main()是Java程序入口
 */
public static void main(String[] args) {
	// 单行注释，以下代码向控制台输出一句话
	System.out.println("Hello World!");
	// System.out.println("这行代码注释掉了，不会被执行!");
	
}

注释也可以帮助我们调试程序，当程序出现 Bug，注释可以辅助排除错误。在代码中使用注释来排查错误非常有帮助。你可以注释掉部分代码，逐步测试和调试，以确定具体的错误发生在哪个代码段，并逐步缩小问题的范围。

四、文档注释

Java 中除了单行注释、多行注释，还提供了一种功能更强大的注释形式：文档注释。

1.文档注释

文档注释（Documentation comments）：是一种特殊类型的注释，以斜线星号星号（ /** ）开头和星号斜线（ */ ）结尾，位于类、方法或变量声明之前。 文档注释支持使用一些特殊的标签，如 @author、@version、@param、@return、@throws 等，用于提供对应信息的文档说明。可以通过 Java 工具（javadoc）自动生成 API 文档，方便其他开发人员查阅和使用你的代码。同样，文档注释会被编译器忽略，不会被执行。

/**
 * Java Hello World
 *
 * @since 2023/7/6 18:16
 * @author root
 * @version 1.0
 */
public class HelloWorld {

	/*
		多行注释
		main()是Java程序入口
	*/
	public static void main(String[] args) {
		// 单行注释，以下代码向控制台输出一句话
		System.out.println("Hello World!");
		// System.out.println("这行代码注释掉了，不会被执行!");

	}
}