Java基础01——注释

Java注释

• 平时我们编写代码，在代码量比较少的时候，我们还可以看懂自己写的，但是当项目结构一旦复杂起来，我们就需要用到注释了。
• 注释并不会被执行，是给我们写代码的人看的。
• 书写注释是一个非常好的习惯。

---

Java的三种注释

1. 单行注释

   • 以双斜杠 // 标识，只能注释一行内容，用在注释信息内容少的地方。

   • 语法：// 注释内容

   • 示例：

     public class Test {
         public static void main(String[] args) {
             // 这是一个单行注释，“//” 后面的都会被注释
             System.out.println("Hello,World!");// 输出一句 Hello，World！
         }
     }
     

2. 多行注释

   • 包含在 /* 和 */ 之间，能注释很多行的内容。

   • 语法：/* 注释内容 */

   • 示例：

     public class Test {
         public static void main(String[] args) {
             /*
             这是一个多行注释
             可以注释多行
             输出一句 Hello，World！
              */
             System.out.println("Hello,World!");
         }
     }
     

3. 文档注释

   • 包含在 /** 和 */ 之间，也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。

   • 语法：/** 注释内容 */

   • 示例：

     public class Test {
         public static void main(String[] args) {
             /**
              *
              * 这是一个文档注释
              * 可以注释多行
              * 文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档，并输出到 HTML 文件中，方便记录程序信息。
              * 输出一句 Hello，World！
              */
             System.out.println("Hello,World!");
         }
     }
     

小彩蛋

/***
 * _ooOoo_
 * o8888888o
 * 88" . "88
 * (| -_- |)
 *  O\ = /O
 * ___/`---'\____
 * .   ' \\| |// `.
 * / \\||| : |||// \
 * / _||||| -:- |||||- \
 * | | \\\ - /// | |
 * | \_| ''\---/'' | |
 * \ .-\__ `-` ___/-. /
 * ___`. .' /--.--\ `. . __
 * ."" '< `.___\_<|>_/___.' >'"".
 * | | : `- \`.;`\ _ /`;.`/ - ` : | |
 * \ \ `-. \_ __\ /__ _/ .-` / /
 * ======`-.____`-.___\_____/___.-`____.-'======
 * `=---='
 *          .............................................
 *           佛曰：bug泛滥，我已瘫痪！
 */

百度搜索 有趣的代码注释，会有很多这样的注释。