《21天学通Java(第7版)》—— 2.3 注释

简介: 为提高程序的可读性,最有效的方式之一是使用注释。注释是程序中的文本,说明了代码的作用。Java编译器在生成Java源代码文件的字节码版本时忽略注释,因此使用注释不会带来任何危害。 在Java程序中,可以使用3种不同的注释。

本节书摘来异步社区《21天学通Java(第7版)》一书中的第2章,第2.3节,作者: 【美】Rogers Cadenhead(罗格斯 卡登海德),更多章节内容可以访问云栖社区“异步社区”公众号查看。

2.3 注释

为提高程序的可读性,最有效的方式之一是使用注释。注释是程序中的文本,说明了代码的作用。Java编译器在生成Java源代码文件的字节码版本时忽略注释,因此使用注释不会带来任何危害。

在Java程序中,可以使用3种不同的注释。

单行注释以两个斜杠(//)打头。从这些斜杠到行尾的所有内容都是注释,Java编译器将忽略它们,如下面的语句所示:

int creditHours = 3; // set up credit hours for course
从这些斜杠到行尾的所有内容都被忽略,因此在编译器看来,上述代码行与下面的代码等效:

int creditHours = 3;
多行注释以/打头,以/结束。这两个分界符之间的所有内容(可以横跨多行)都被视为注释,如下所示:

/* This program occasionally deletes all files on
your hard drive and renders it unusable
forever when you click the Save button. */

Javadoc注释以/*打头,/以结束。这些分界符之间的内容都被视为用于描述类及其方法的官方文档。

Javadoc注释可被诸如javadoc(JDK中的一个命令行工具)等实用程序读取。javadoc使用这种注释来创建一组网页,用于说明Java类的功能、指出Java类在继承层次结构中的位置、描述其每个方法。

Java类库中每个类的官方文档都是根据Javadoc注释生成的。

附录E介绍了如何使用工具javadoc。

相关文章
|
Java 数据安全/隐私保护
java实现加密电话号码,有具体的加密流程注释
java实现加密电话号码,有具体的加密流程注释
21 0
|
6月前
|
Java Spring
【Java用法】Spring之@Nullable和@NotNull注释的使用
【Java用法】Spring之@Nullable和@NotNull注释的使用
77 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——实体层(User.java)
mybatis简单案例源码详细【注释全面】——实体层(User.java)
13 0
|
3天前
|
Java 开发者
Java基础知识整理,注释、关键字、运算符
在日常的工作中,总会遇到很多大段的代码,逻辑复杂,看得人云山雾绕,这时候若能言简意赅的加上注释,会让阅读者豁然开朗,这就是注释的魅力!
37 11
|
1月前
|
Java 编译器 API
Java注释
Java注释
12 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——Utils层(MybatisUtils.java)
mybatis简单案例源码详细【注释全面】——Utils层(MybatisUtils.java)
13 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——测试层(UserMapperTest.java)
mybatis简单案例源码详细【注释全面】——测试层(UserMapperTest.java)
9 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——实体层(Role.java)
mybatis简单案例源码详细【注释全面】——实体层(Role.java)
7 0
|
1月前
|
Java 程序员 编译器
Java注释
Java注释
14 0
|
1月前
|
Java 测试技术 API
滚雪球学Java(10):Java注释
【2月更文挑战第22天】🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,助你一臂之力,带你早日登顶🚀,欢迎大家关注&&收藏!持续更新中,up!up!up!!
64 2