> 文档中心 > Java基础篇 第3节 注释_用法_三种注释风格_注释的编译

Java基础篇 第3节 注释_用法_三种注释风格_注释的编译

文章目录

  • ❇️注释
    • 💙什么是注释?
    • ❤️为什么要写注释?
    • 💛注释会编译吗?
    • ✅三种注释风格
      • 1️⃣单行注释
      • 2️⃣多行注释
      • 3️⃣文档注释

❇️注释

💙什么是注释?

  在任意的编程语言中都会支持以特定的格式书写注释,注释可以看作是一种特定格式的代码,只产生在编写代码的环节,不会去执行,只是为了方便程序员在写程序的过程中能够瞬间明白某些语段的含义或者实现的功能的一种语句。

❤️为什么要写注释?

  在个人开发中,我们通过书写代码注释,能够一目了然的获取到所书写代码的功能或含义,方便我们进行代码的管理和使用。
  在某段代码放置长时间后,我们重新阅读该段代码时,如果没有注释我们并不能够直接的获取到所需要的信息,而需要重新阅读代码详情,去重新观测实现的什么功能,代表的什么含义,这时会造成精力的浪费,甚至我们在写完一个模块以后,过段时间再阅读,甚至会出现读不懂的情况。
  在企业或者团队开发中,我们必须要书写代码注释,我们不能够认为我们自己写的程序,自己能看懂,自己能知道其中的含义,而没有书写代码注释,那么当团队中其他人需要用到此段代码的时候,一般情况下是不会自己去编写,而是从相关来源中进行调用,这时如果没有注释,那么同事将无法判断其功能,需要重新去阅读,甚至重新编写,大大降低了开发的效率,所以不仅仅为了自己方便回忆,也方便他人进行代码的复用,做到事半功倍。

💛注释会编译吗?

  在Java中,编译过程中,编译器会将代码中的所有注释信息全部去除,因为注释是写给人看的,而不是写给编译器的,而且代码中的注释也不会进行执行,所以为了程序的大小,编译器通常会帮我们将代码中的注释去除掉,然后再进行编译,那么也就是说,注释是不会被编译执行的。

✅三种注释风格

1️⃣单行注释

// 这是单行注释,只能写一行

public class Hello{public static void main(String[] args){// 这是单行注释,只能写一行System.out.println("Hello World!");}}

2️⃣多行注释

public class Hello{public static void main(String[] args){/** 这是多行注释,可以写很多行*/ System.out.println("Hello World!");}}

3️⃣文档注释

文档注释的内容在生成文档的时候,会自动提取出来,显示在文档之中。

/***这是文档注释,需要写在类外面*/public class Hello{public static void main(String[] args){System.out.println("Hello World!");}}