为什么要给代码添加注释？

在编写程序时，为了使代码易于阅读，通常会在实现功能的同时为代码添加一些注释。注释是对程序的某个功能或者某行代码的解释说明，它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。

注释只在Java源文件中有效，在编译程序时编译器会忽略这些注释信息，不会将其编译到class字节码文件中。

Java中的注释有三种类型，具体如下：

1．单行注释

单行注释通常用于对程序中的某一行代码进行解释，用符号“//”表示，“//”后面为被注释的内容，具体示例如下：

int c = 10;      // 定义一个整型变量c

2．多行注释
多行注释顾名思义就是可以同时为多行内容进行统一注释，它以符号“/”开头，并以符号“/”结尾，具体示例如下：

/* 定义一个整形变量x
将5赋值给变量x */
int x;
x = 5;

3．文档注释
文档注释通常是对程序中某个类或类中的方法进行的系统性的解释说明，开发人员可以使用JDK提供的javadoc工具将文档注释提取出来生成一份API帮助文档。文档注释以符号“/”开头，并以符号“/”结尾，具体示例如下：

/*** Title：HelloWorld类* @author srx* @version 1.0    */
public class HelloWorld {/*** 这是一个main()方法入口* @param args 参数名*/public static void main(String[] args){System.out.println("这是第一个Java程序！");}
}

注释嵌套：

在Java中，有的注释可以嵌套使用，有的则不可以，下面列举两种具体的情况。

1．多行注释“/…/”中可以嵌套使用单行注释“//”，具体示例如下：

/* int c = 10;  // 定义一个整型的cint x = 5; */

2．多行注释“/…/”中不能嵌套使用多行注释“/…/”，具体示例如下：

/*/*int c = 10;*/int x=5;
*/

上面第二种情况的代码就无法通过编译，原因在于第一个 “/”会和第一个“/”进行配对，而第二个“*/”则找不到匹配，就会编译失败。

针对在使用嵌套注释时可能出现编译异常这一问题，通常在实际开发中都会避免对代码注释进行嵌套使用，只有在特殊情况下才会在多行注释中嵌套使用单行注释。

为什么要给代码添加注释？相关推荐

HTML中如何给代码添加注释
HTML注释有四种类型. 1. 单行注释用户可以对单行进行评论.请注意,单行注释以特殊箭头开头.然后编译器会忽略正斜杠和行尾之间的内容. 在代码行之前使用单行注释的示例如下: < User ...
Visual Studio中使用Macros插件给代码添加注释、时间和以及自动脚本
title: Visual Studio中使用Macros插件给代码添加注释.时间和以及自动脚本 date: 2020-09-11 sidebarDepth: 2 tags: 代码 Visual st ...
dw如何快速注释php代码,dreamweaver cs6如何添加注释
dreamweaver cs6官方电脑版下载(32位64位) 软件大小:278MB授权方式:免费软件立即下载 Dreamweaver是集网页制作和管理网站于一身的所见即所得网页代码编辑器,又叫做可视 ...
Visual Studio+VAssistX自动添加注释，函数头注释，文件头注释
在VAssistX中为C++提供了比较规范注释模板,用这个注释模板为编写的C++代码添加注释是很便捷的选择,操作起来也很简单,具体方法和步骤如下: 1.增加函数头注释之后注释模板中编辑自己需要的注释 ...
MATLAB中添加注释
MATLAB中添加注释的方法: 1. 选中想要注释的代码,然后加入"%"符号,可以看到,代码的颜色从黑色变成了绿色即为注释成功: 2.可以使用快捷键:Ctrl+R给选中的代码添加注 ...
【Android 逆向】IDA 工具使用 ( 重命名函数 | 添加注释 | 添加标签 / 跳转标签 | 代码跳转前进 / 后退 )
文章目录一.重命名函数二.添加注释三.添加标签 / 跳转标签四.代码跳转前进 / 后退一.重命名函数针对一个匿名函数 , 在分析函数时 , 可以为匿名函数进行命名 ; 右键点击函数名 ...
Eclipse中代码自动添加注释及代码注释模板
介绍为了提高代码的可读性以及为了有些代码有洁癖的人的需求,我们要从学生到职业进行迈进的过程中,必须把以前的那种代码可读性不高的习惯改掉,因为我们必须要与企业接轨.. 好了,废话不多说,反正就是提升自 ...
java-在IDEA中,如何在代码和注释之间自动添加空格？
例范例A: T result = (T) node.value; // keep return value, 之间有间隔;和// 范例B: if (k < 0 || k > size) ...
java注释里加_如何在代码中添加注释
什么是代码注释,如何在代码中添加注释,相信每一位了解编程的人并不陌生.注释里往往有很多有趣的脑洞和「真心话」.今天我们一起去看看那些6到飞起,被玩坏了的幽默注释吧. 信息量太大的注释系列-- 1.你造 ...

为什么要给代码添加注释？

为什么要给代码添加注释？相关推荐

最新文章

热门文章