JAVA 注释

注释

注释,是对代码的解释和说明,不影响程序的编译和运行。

其目的是让人们能够更加轻松地了解代码。为代码添加注释,是十分必要的

三种注释以及应用场景

对代码的说明、解释,不参与代码的编译

注释对开发工程师,对开发小组、公司来说,非常重要

1、单行注释

//可以注释一行

多用于说明注释下一行的变量或代码作用

2、多行注释

/*
可以写多行
*/

多用于说明某段代码的作用

3、文本注释

/**
可以生成文档
*/

在每个方法、属性、类上回填写文本注释,用于 生成 API 说明文档

idea 演示生成API文档

设置字符集:

-encoding utf-8 -charset utf-8

原文出处:/show_1EF4uroZtiE5.html