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


三、小结

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


相关文章
|
2月前
|
安全 Java
Java异常处理:程序世界的“交通规则
Java异常处理:程序世界的“交通规则
335 98
|
3月前
|
存储 Java 编译器
对比Java学习Go——程序结构与变量
本节对比了Java与Go语言的基础结构,包括“Hello, World!”程序、代码组织方式、入口函数定义、基本数据类型及变量声明方式。Java强调严格的面向对象结构,所有代码需置于类中,入口方法需严格符合`public static void main(String[] args)`格式;而Go语言结构更简洁,使用包和函数组织代码,入口函数为`func main()`。两种语言在变量声明、常量定义、类型系统等方面也存在显著差异,体现了各自的设计哲学。
|
4月前
|
人工智能 监控 安全
智慧工地解决方案,java智慧工地程序代码
智慧工地系统融合物联网、AI、大数据等技术,实现对施工现场“人、机、料、法、环”的全面智能监控与管理,提升安全、效率与决策水平。
149 2
|
9月前
|
存储 Java 数据库连接
【YashanDB知识库】Java程序调用存储过程,在提取clob时报YAS-00004
【YashanDB知识库】Java程序调用存储过程,在提取clob时报YAS-00004
|
9月前
|
搜索推荐 Java Android开发
课时146:使用JDT开发Java程序
在 Eclipse 之中提供有 JDT环境可以实现java 程序的开发,下面就通过一些功能进行演示。 项目开发流程
332 0
|
9月前
|
Java C语言
课时8:Java程序基本概念(标识符与关键字)
课时8介绍Java程序中的标识符与关键字。标识符由字母、数字、下划线和美元符号组成,不能以数字开头且不能使用Java保留字。建议使用有意义的命名,如student_name、age。关键字是特殊标记,如蓝色字体所示。未使用的关键字有goto、const;特殊单词null、true、false不算关键字。JDK1.4后新增assert,JDK1.5后新增enum。
193 4
|
9月前
|
Java 编译器
课时7:Java程序基本概念(注释)
课时7介绍了Java程序中的注释。编程语言有其语法和语义,注释有助于理解代码需求,防止断档。Java支持三类注释:单行(//)、多行(/* */)和文档注释(/** */)。注释不会被编译器编译。范例中展示了如何在代码中使用注释,并强调了注释对项目文档管理的重要性。
212 3
|
9月前
|
Java 开发工具
课时5:第一个Java程序
课时5介绍了编写第一个Java程序的步骤,包括创建Hello.java文件、编写“Hello World”代码、编译和运行程序。主要内容有:1) 新建并编辑Hello.java;2) 编译Java源文件生成.class文件;3) 通过命令行解释执行Java程序;4) 解释主方法的作用及信息输出操作。本课强调了类定义、文件命名规则和基本程序结构的重要性,并建议初学者使用记事本编写代码以熟悉基础语法。
207 0
|
11月前
|
传感器 安全 算法
消防救援支队消防员单兵装备智能养护舱电机驱动java版程序(二)
本文探讨消防救援中智能养护舱电机驱动的Java程序设计,作为系列文章第二部分。通过自动化和智能化手段,智能养护舱提升了装备维护效率与准确性。文章详细介绍了电机驱动模块的设计与实现,包括硬件选型、PID控制策略、安全保护机制及Java程序架构,确保电机精确控制、稳定性和安全性。未来将优化功能并引入智能算法和物联网技术,进一步提升装备维护智能化水平。