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 页面形式的文档


三、小结

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


相关文章
|
5天前
|
XML 存储 JSON
Java程序部署
Java程序部署
|
7天前
|
消息中间件 分布式计算 Java
Linux环境下 java程序提交spark任务到Yarn报错
Linux环境下 java程序提交spark任务到Yarn报错
17 5
|
7天前
|
Java 编译器 数据库连接
探索Java中的异常处理:提升程序的鲁棒性
【9月更文挑战第25天】在Java的世界里,异常是那些不请自来、令人头疼的“客人”。它们悄无声息地潜入我们的代码,一旦出现,便可能导致程序崩溃或行为异常。但是,如果能够妥善管理这些异常,我们就能将潜在的灾难转变为增强程序鲁棒性和用户体验的机会。本文将通过深入浅出的方式,带领读者理解Java异常处理的重要性,并提供实用的策略来优雅地处理这些意外情况。让我们一起学习如何在Java中捕捉、处理和预防异常,确保我们的程序即使在面对不可预见的错误时也能保持稳健运行。
|
14天前
|
监控 Java 数据库
Java程序如何进行不停机更新?
Java程序如何进行不停机更新?
16 1
|
26天前
|
Java API 开发者
Java 注释规范
Java中的注释规范包括单行注释(`//`)、多行注释(`/* ... */`)和文档注释(`/** ... */`)。单行注释适用于简短说明,多行注释用于较长描述,文档注释则专为自动生成API文档设计。注释应清晰明了、及时更新,避免冗余,并详细说明参数和返回值。遵循这些规范有助于提高代码的可读性和可维护性。
|
1月前
|
缓存 监控 安全
如何提高 Java 高并发程序的性能?
以下是提升Java高并发程序性能的方法:优化线程池设置,减少锁竞争,使用读写锁和无锁数据结构。利用缓存减少重复计算和数据库查询,并优化数据库操作,采用连接池和分库分表策略。应用异步处理,选择合适的数据结构如`ConcurrentHashMap`。复用对象和资源,使用工具监控性能并定期审查代码,遵循良好编程规范。
|
2月前
|
Java C# 容器
逻辑运算符Java代码的注释
这段代码及文字介绍了一个简单的Java程序以及Java编程的基础概念。代码展示了如何输出“Hello Word”。接着,用贴近生活的比喻解释了`package`(包)、`public`(访问修饰符)、`class`(类)、`static`(静态)和`void`(空)的概念。此外,还介绍了`System.out.println()`方法。进一步讲解了Java中的注释、数据类型(包括整型、浮点型、字符型和布尔型),变量和常量的概念,以及运算符、类型转换、赋值运算符、关系运算符与逻辑运算符等基础知识点。通过生动的例子帮助初学者更好地理解和记忆。
22 2
|
2月前
|
数据采集 人工智能 监控
【Azure 应用程序见解】Application Insights Java Agent 3.1.0的使用实验,通过修改单个URL的采样率来减少请求及依赖项的数据采集
【Azure 应用程序见解】Application Insights Java Agent 3.1.0的使用实验,通过修改单个URL的采样率来减少请求及依赖项的数据采集
|
2月前
|
Java jenkins Shell
还有人不会启动JAVA程序
还有人不会启动JAVA程序
16 0
|
2月前
|
Java 调度
下一篇
无影云桌面