Java学习笔记2.1.2 Java基本语法 - Java三种注释方式

Posted 2022-03-04 howard2005

文章目录

• 零、本讲学习目标
• 一、注释的作用
• 二、注释的分类
• • （一）简单说明
  • • 1、单行注释
    • 2、多行注释
    • 3、文档注释
  • （二）案例演示
  • （三）注释的嵌套
  • • 1、简单说明
    • 2、案例演示
• 三、养成写注释的良好习惯

零、本讲学习目标

1. 掌握Java单行注释
2. 掌握Java多行注释
3. 掌握Java文档注释

一、注释的作用

• 在编写程序时，为了使代码易于阅读，通常会在实现功能的同时为代码添加一些注释。注释是对程序的某个功能或者某行代码的解释说明，它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。
• 注释只在Java源文件中有效，在编译程序时编译器会忽略这些注释信息，不会将其编译到class字节码文件中。建议大家养成给程序添加必要注释的良好习惯。

二、注释的分类

（一）简单说明

1、单行注释

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

2、多行注释

• 多行注释顾名思义就是可以同时为多行内容进行统一注释，它以符号“/*”开头，并以符号“*/”结尾。

3、文档注释

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

（二）案例演示

• 创建c02.s01.p02包，在包里创建Example01类
  
• 利用IDEA可以生成项目的API文档
  
  
• 生成的文档在D:\\java_work目录里，打开首页index.html即可查看生成的API文档
  

（三）注释的嵌套

1、简单说明

• 多行注释“/*…*/”中可以嵌套使用单行注释“//”。
• 多行注释“/*…*/”中不能嵌套使用多行注释“/*…*/” 。

2、案例演示

• 在c02.s01.p02包里创建Example02类
  

三、养成写注释的良好习惯

• 注释是很重要的，特别在一些大公司里，对于注释的要求特别高，看一个程序员的水平高低，一般看他的注释就能看出来，所以平常养成写注释的好习惯对应程序员来说是很重要的。一般注释和源代码的比例是1:1，甚至1:2或者1:3。
• 自己就有这种体会。别人发来代码要我修改，一看源代码那叫惨不忍睹，密密麻麻的一片，不见一个中文（当然写英文注释还是可以理解的）。修改起来这叫我痛不欲生啊！自己要里弄懂每个变量，每个语句是什么含义，这个代码块是什么作用，如此等等。反正我是受不了这种摧残，还不如叫我自己实现这个功能。所以写好代码的注释不仅是你受用，别人也会受益匪浅。
• 优美的代码是必须要有注释的。阅读注释详细、稳妥的代码是种享受，或许只有程序员才能体会其中的乐趣吧。
• 平时注意这个习惯，写好注释。一是因为别的程序员会使用你的程序，增加程序的可读性。别人使用起来方便，如果没有注释，别的程序员还不如自己重新写，这样效率或许会快些。二是自己以后也需要阅读，人的记忆不可能永远那么好，总有忘记的时候。所以写好注释可以让自己快速地明白当初自己写代码的含义，这样会事半功倍。
• 从现在开始，给代码写上注释吧，让自己走得更稳，更远。