网站首页 > java教程 正文
概述:
几乎所有编程语言都允许程序员在代码中输入注释(comment),编译器会忽略注释的内容。因此,注释不会影响程序的运行结果。注释的真正作用是:它可以向任何阅读代码的人描述或者解释程序的实现思路、如何使用以及其他任何相关信息。
JAVA中的注释
JAVA提供了三种注释方式,方便我们在不同的场景去使用:
1、单行注释
如果程序中的每一行是以//开头的,那么这行就是一个单行注释,例如:
2、多行注释
程序中,以/*,以*/结尾,中间的所有的内容都是注释,虽然这种注释叫做多行注释,但是注释的内容可以是单行的,也可以是多行的,例如:
3、javadoc注释
javadoc注释又叫做归档注释,也叫作说明注释。它是以/**开头。以*/结尾,例如:
因为注释的内容可以是任何字符,仔细对比多行注释和javadoc注释,我们会发现,如果我们把javadoc注释(以/**开头)开头的第二个*当做注释内容的话,他就会变成一个多行注释(以/*开头),从这个角度看的话,我们可以说javadoc注释就是一种特殊的多行注释。但是这样的结果是不对的,因为javadoc注释的真是用处是,它允许我们在程序中嵌入关于程序本身的信息,Javadoc的工具软件通过识别这些信息输出HTML版本的说明文档。这是至关重要的,尤其是在真实的项目中。
在javadoc注释中,我们通过一些标签来说记录程序信息,javadoc工具软件能够识别的标签如下图所示:
Javadoc注释一般用来注释类和方法,通过上表的标签来记录类或者方法的信息,例如:
我们可以通过javadoc工具来处理一下NumberTest.java这个文件:
经过javadoc软件处理之后,我们得到一些说明性的html文件,如下:
我们打开index.html,看到的就是关于NumberTest类的说明:
看到这个结果,你知道平时看的JDK的那些API是怎么来的了吗?这就是javadoc注释的伟大作用。
注释在实战中的应用
企业级产品开发中,对注释的要求取决于项目的规模和团队的正规化程度。对于一个专业的软件开发人员来说,对javadoc的使用程序有时候直接决定这在项目中的角色,也会影响面试的结果和薪水的水平,因为它能够反映开发人员参与过项目的规模,以及之前躲在团队的专业化程度。
对注释的重视是一个专业团队必不可少的一部分。一般来说,每个专业的团队都有一个关于注释的书写规范要求,下面我给出注释规范供大家参考:
1、版权注释
2、类注释
3、构造方法注释
4、其他方法注释
5、代码块注释
6、单句注释
7、字段名注释
- 上一篇: Java注释——课后笔记(java的注释怎么写)
- 下一篇: 该怎么运用注解呢?Java团队元老有话说
猜你喜欢
- 2024-10-12 Java文档注释四种_Java注解(java注释格式范例)
- 2024-10-12 Java注解原理详解(4大原理步骤)(java注解的工作原理)
- 2024-10-12 Java核心知识2:注解机制详解(java核心技术注解在哪一章)
- 2024-10-12 Java注释案例(java中注释有几种及用法)
- 2024-10-12 JAVA注释规范(java注释格式范例)
- 2024-10-12 Java注解(Annotation)简介(java注解documented)
- 2024-10-12 java 注解(java注解怎么写)
- 2024-10-12 Java 第二天 - Java 注释(java里面的注释)
- 2024-10-12 Java 注解详解(java注解教程)
- 2024-10-12 java笔记 程序注释(java程序的注释符号有哪些)
你 发表评论:
欢迎- 07-15采用Oracle OSB总线进行服务注册和接入
- 07-15javaEE 新闻管理系统 oracle11+tomcat6
- 07-15从Oracle演进看数据库技术的发展(oracle数据库发展史)
- 07-15如何升级oracle数据库安全补丁(oraclepsu补丁升级)
- 07-15【权威发布】关于Oracle WebLogic Server未授权远程代码执行高危漏洞的预警通报
- 07-15【mykit-data】 数据库同步工具(数据库表同步工具)
- 07-15[Java速成] 数据库基础,Connector/J、JDBC、JPA的关系(day 7)
- 07-15Google前工程主管“入住”Oracle(google浏览器找不到以前的书签)
- 最近发表
-
- 采用Oracle OSB总线进行服务注册和接入
- javaEE 新闻管理系统 oracle11+tomcat6
- 从Oracle演进看数据库技术的发展(oracle数据库发展史)
- 如何升级oracle数据库安全补丁(oraclepsu补丁升级)
- 【权威发布】关于Oracle WebLogic Server未授权远程代码执行高危漏洞的预警通报
- 【mykit-data】 数据库同步工具(数据库表同步工具)
- [Java速成] 数据库基础,Connector/J、JDBC、JPA的关系(day 7)
- Google前工程主管“入住”Oracle(google浏览器找不到以前的书签)
- Oracle数据库云服务系列新增前所未有的企业级功能
- 直播预告丨如何实现Oracle存储过程到java的一键转化
- 标签列表
-
- java反编译工具 (77)
- java反射 (57)
- java接口 (61)
- java随机数 (63)
- java7下载 (59)
- java数据结构 (61)
- java 三目运算符 (65)
- java对象转map (63)
- Java继承 (69)
- java字符串替换 (60)
- 快速排序java (59)
- java并发编程 (58)
- java api文档 (60)
- centos安装java (57)
- java调用webservice接口 (61)
- java深拷贝 (61)
- 工厂模式java (59)
- java代理模式 (59)
- java.lang (57)
- java连接mysql数据库 (67)
- java重载 (68)
- java 循环语句 (66)
- java反序列化 (58)
- java时间函数 (60)
- java是值传递还是引用传递 (62)
本文暂时没有评论,来添加一个吧(●'◡'●)