栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Java 中的注释

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Java 中的注释

1.注释的作用

        注释是对代码的解释和说明,其目的是让程序员能够更加快速的理解代码。它是编写程序时,写程序的人给一个语句、程序段等的解释或提示,能提高程序代码的可读性。添加注释,是为了程序更容易理解与维护,特别是维护,更是对自己代码负责的一种体现。
        注释在编译的时候不会生成到 class 字节码文件当中,它只在 java 源文件中保留。

2.注释的三种方式
        
      (1)单行注释,语法格式如下:
                // 单行注释,两个正斜杠后面的内容被注释
      (2)多行注释,语法格式如下:
                
       (3)javadoc 注释
                
        注意:对于 javadoc 注释来说,这里的注释会被 JDK bin 目录下的 javadoc.exe 命令解
析并生成帮助文档(生成帮助文档后期做项目的时候大家会接触到的)。

3.注释应该怎么写

        编写注释是程序员最基本的素养,养成编写注释的好习惯,要有编写注释的意识。当然,
写注释也是有技巧的,不是所有位置都写,不是把写的代码原版翻译过来,老程序员往往在写
注释的时候,不多不少,能够做到恰到好处,几句话就可以描述清楚程序的核心功能。
        通常要在类和接口上写注释,这一部分注释是必须的。在这里,我们需要使用 javadoc 注释,需要标明:创建者,创建时间,版本,以及该类的作用。在方法中,我们需要对入参、出参以及返回值,均要标明。对常量,我们需要使用多行注释,标明该常量的用途。在关键算法上,添加注释并且按照顺序依次标明,写明白该方法为什么这么做。
        注意:注释的作用不在于表示代码的含义,而在于表示代码的功能。

4.为HelloWorld提供注释

        接下来我们为HelloWorld程序提供简单的注释信息,来联系一下注释的编写:

public class HelloWorld {
     
 public static void main(String[] args) {
         // 向控制台输出一段话
         System.out.println("HelloWorld");
    }
}
        通过以上代码我们可以看到,HelloWorld 类上写了一个 javadoc 注释,在 javadoc 注释中提 供了对这个类的整体描述信息、作者信息、版本号信息等。在 main 方法上提供了 javadoc 注 释,对这个方法进行了说明,对参数进行了说明等。在输出信息的那行代码上提供了单行注释, 说明了这行代码的作用。
     提示:可以使用注释调试代码     在进行代码的开发时,如果发现某段代码可能暂时不需要的话,不用删除,最好使用注释的方式将其注释起来,这样就不会进行编译了。
         (本文仅代表个人观点,不喜勿喷!)
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/704421.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号