Java基础——注释

ops/2024/10/24 9:23:49/

在开发中注释是必不可少的,帮助我们更好的标记阅读代码,下面介绍几种常用的注释方式。

一、注释种类

1. 单行注释

使用//一行代码来进行注释,只能注释一行内容
请添加图片描述

2. 多行注释

使用斜杠+星号的方式 /*注释多行代码*/,注释多行代码
请添加图片描述

3. 文档注释

使用/**文档注释内容*/ 来注释文档内容,一般文档注释用于类、方法、成员变量上
请添加图片描述

二、JavaDoc

Javadoc 是 Sun 公司提供的一种工具,通过JavaDoc我们可以生成一个源码对应的帮助文档。

1. 常见标签

JavaDoc工具定义了一些识别注释标签,常用的标签如下:

  • @author:标识一个类的作者,一般用于类注释
  • @exception可能抛出异常的说明,一般用于方法注释
  • @param:说明一个方法的参数,一般用于方法注释
  • @return:说明返回值类型,一般用于方法注释,不能出现再构造方法中
  • @throws:和 @exception 标签一样
  • @version :指定类的版本,一般用于类注释

2. 用法命令

通过javadoc -help命令我们可以查看用法帮助
请添加图片描述

javaDoc_27">3.类的javaDoc注释

请添加图片描述

4.方法的JavaDoc注释

请添加图片描述

4.变量的JavaDoc注释

请添加图片描述


http://www.ppmy.cn/ops/95330.html

相关文章

Unity协程WaitForSeconds在编辑器和WebGL表现不同问题的解决方法参考

最近做的一个效果让下面为了让下面这种图片生成一个翻页效果(使用ShaderGraph中的FlipBook节点),我通过携程来实现连续翻页。 先是定义一个Coroutine coroutine null; 然后在一定情况下执行coroutine StartCoroutine(KeepPrevie…

【Datawhale AI夏令营第四期】 魔搭-大模型应用开发方向笔记 Task02 精读BaseLine代码

【Datawhale AI夏令营第四期】 魔搭-大模型应用开发方向笔记 Task02 学习BaseLine代码 Task02学习链接: https://linklearner.com/activity/14/11/30 学习期间听了开营仪式,在老师的介绍下才发现跑完BaseLine以后学习手册还有后半部分的知识&#xff0c…

AI赋能软件测试:从自动化到智能化,让测试工作事半功倍

引言 在当今这个日新月异的数字时代,人工智能(AI)正以不可阻挡之势渗透并重塑着各行各业,其中,软件开发与测试领域更是迎来了前所未有的变革。随着软件系统的复杂性日益增加,用户对软件质量、性能及安全性的…

C语言传递指针给函数

C 语言允许您传递指针给函数,只需要简单地声明函数参数为指针类型即可。 下面的实例中,我们传递一个无符号的 long 型指针给函数,并在函数内改变这个值 实例1:获取系统的时间值 能接受指针作为参数的函数,也能接受数…

MES系统从哪几方面提升企业制造水平?

在当今这个快速变化的制造环境中,企业对于提升制造水平的追求从未停止。制造执行系统(MES)作为连接企业战略规划与车间实际操作的核心工具,其重要性日益凸显。盘古信息MES系统,凭借其独特的功能模块和创新的设计理念&a…

力扣 58. 最后一个单词的长度

题目描述 思路 下意识想到先以空格作为分割符对字符串进行分割得到若干个子字符串,然后用字符串长度计算函数计算最后一个子字符串的长度。 该思路代码如下: class Solution:def lengthOfLastWord(self, s: str) -> int:s_array s.split()last_le…

外卖系统小程序安卓app如何开发运营?

外卖系统的有效开发是一个复杂而系统的过程,需要综合考虑需求分析、系统设计、技术选型、开发实施、测试上线以及后期维护等多个方面。以下是一个详细的开发流程建议: 一、需求分析 用户调研:深入了解目标用户群体(包括消费者、…