Java 程序中的注释

简介: Java 程序中的注释

Java 程序中的注释

注释就是对代码进行解释说明的文字,一般的程序设计语言都提供了程序注释,通过注释可以让别人或者自己读懂编写的程序。

==程序中的注释不是程序的语句部分,它可以放在任何地方,系统在编译时会忽略掉==

举个例子:我今天写了一个程序,程序里面没有写注释,这个时候自己还可以看懂,然后过了一个月再回来看自己写的程序,就发现只有天知道这个程序到底写了些什么了。

写注释还是一个很重要的习惯,Java 提供了两种注释方式:==程序注释和程序文档注释==


一、程序注释

1、单行注释

单行注释以双斜杠( // )开始

以 “ // ” 开始后面跟注释的文字;这种注释方式可以独占一行,也可以跟在程序语句的后面,例:

public class test{
   
    //下面这句是 main 方法,表示程序的入口(这个就是单独占一行的注释)
    public static void mian(String[] args)
    {
   
        System.out.println("Hello World!!!");    //这句是 Java 程序的输出语句,打印输出小括号里面的内容(这个就是跟着程序语句后面的注释)
    }
}

2、多行注释

多行注释以 “ / ” 开始,以 “ / ” 结束

当需要多行注释时,一般使用 “ / ······ / ” 格式作为注释,中间的 “ ······ ” 为注释的内容,例:

public class test{
   
    public static void main(String[] args)
    {
   
        /*
            上面这句是 main 方法,表示程序的入口
            下面这句是 Java 程序的输出语句,打印输出小括号里面的内容
        */
        System.out.println("Hello World!!!");
    }
}

二、程序文档注释

程序文档注释是一种特有的注释方式,它规定了一下专门的标记,其目的是自动生成独立的程序文档。

程序注释通常用于注释类、接口、变量和方法,例:

/**
* 该类中包含了一些操作数据库常用的基本方法
* 在数据表中进行添加、修改、删除、查询操作
* 其他数据信息
* @author Zhang San
* @version 3.1,30/07/2022
* @since JDK1.8
*/

在上面的程序文档注释中,除了说明文字之外,还有一些有 @ 字符开头的专门标记,
@author 用于说明本程序代码的作者
@version 用于说明程序代码的版本以及发布时间
@since 用于说明开发程序代码的软件环境
此外,文档中还可以包含 HTML 标注,在Java 中 JDK 提供了文档生成工具 javadoc.exe 能够识别一些特殊的标记和标注,并根据这些注释生成超文本 Web 页面形式的文档


三、小结

在实际的开发过程中,很多人会觉得注释没有用,但实际上事实恰恰相反,一个好的注释习惯可以让你在学习过程中记住的东西更多,在回过头在复习的时候也会更加的方便。就算是到了工作里面,在公司交接时,通过代码注释也可以让交接工作变得更加的轻松。


相关文章
|
1月前
|
Java 流计算
利用java8 的 CompletableFuture 优化 Flink 程序
本文探讨了Flink使用avatorscript脚本语言时遇到的性能瓶颈,并通过CompletableFuture优化代码,显著提升了Flink的QPS。文中详细介绍了avatorscript的使用方法,包括自定义函数、从Map中取值、使用Java工具类及AviatorScript函数等,帮助读者更好地理解和应用avatorscript。
利用java8 的 CompletableFuture 优化 Flink 程序
|
2月前
|
XML 存储 JSON
Java程序部署
Java程序部署
|
29天前
|
Java 测试技术 程序员
💡Java 零基础 | 深入理解注释的重要性与应用
【10月更文挑战第10天】本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
24 5
|
29天前
|
Java Maven 数据安全/隐私保护
如何实现Java打包程序的加密代码混淆,避免被反编译?
【10月更文挑战第15天】如何实现Java打包程序的加密代码混淆,避免被反编译?
42 2
|
1月前
|
安全 Java Linux
java程序设置开机自启
java程序设置开机自启
|
1月前
|
运维 Java Linux
【运维基础知识】Linux服务器下手写启停Java程序脚本start.sh stop.sh及详细说明
### 启动Java程序脚本 `start.sh` 此脚本用于启动一个Java程序,设置JVM字符集为GBK,最大堆内存为3000M,并将程序的日志输出到`output.log`文件中,同时在后台运行。 ### 停止Java程序脚本 `stop.sh` 此脚本用于停止指定名称的服务(如`QuoteServer`),通过查找并终止该服务的Java进程,输出操作结果以确认是否成功。
35 1
|
2月前
|
消息中间件 分布式计算 Java
Linux环境下 java程序提交spark任务到Yarn报错
Linux环境下 java程序提交spark任务到Yarn报错
42 5
|
2月前
|
Java 编译器 数据库连接
探索Java中的异常处理:提升程序的鲁棒性
【9月更文挑战第25天】在Java的世界里,异常是那些不请自来、令人头疼的“客人”。它们悄无声息地潜入我们的代码,一旦出现,便可能导致程序崩溃或行为异常。但是,如果能够妥善管理这些异常,我们就能将潜在的灾难转变为增强程序鲁棒性和用户体验的机会。本文将通过深入浅出的方式,带领读者理解Java异常处理的重要性,并提供实用的策略来优雅地处理这些意外情况。让我们一起学习如何在Java中捕捉、处理和预防异常,确保我们的程序即使在面对不可预见的错误时也能保持稳健运行。
|
1月前
|
Java Python
如何通过Java程序调用python脚本
如何通过Java程序调用python脚本
27 0
|
2月前
|
监控 Java 数据库
Java程序如何进行不停机更新?
Java程序如何进行不停机更新?
94 1