Java基础——注释

news2024/9/22 9:39:35

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

一、注释种类

1. 单行注释

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

2. 多行注释

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

3. 文档注释

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

二、JavaDoc

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

1. 常见标签

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

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

2. 用法命令

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

3.类的javaDoc注释

请添加图片描述

4.方法的JavaDoc注释

请添加图片描述

4.变量的JavaDoc注释

请添加图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2043336.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

计算机毕业设计 《计算机基础》网上考试系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点…

Idea启动Tomcat控制台中文乱码

Idea配置Tomcat后启动,控制台显示中文乱码 网上搜索资料会发现有要改server.xml URIEncodingUTF-8的,有要改idea文件夹下idea64.exe.vmoptions添加-Dfile.encodingUTF-8的,有要在idea里Tomcat配置中VM Options指定-Dfile.encodingUTF-8的。其…

指令及指令系统

1.指令的基本格式 1.1指令系统 指令(机器指令)是指示计算机执行某种操作的命令。一台计算机的所有指令的集合构成该机的指令系统,也称指令集。 指令系统是指令集体系结构(ISA)中最核心的部分,ISA完整定义了软件和硬件之间的接口,是机器语…

7.1 多态案例

一、案例1&#xff1a;计算器类 1.1 普通方式实现 #include <iostream> #include <string> using namespace std;class Calculator { public:int num1;int num2;int result(string oper){if (oper "")return num1 num2;else if (oper "-"…

法线纹理贴图计算(切线空间世界空间)

效率&#xff1a; 在切线空间中计算&#xff0c;效率更高&#xff0c;因为可以在顶点着色器中就完成对光照、视角方向的矩 阵变换&#xff0c;计算量相对较小。( 矩阵变换在顶点着色器中计算) 在世界空间中计算&#xff0c;效率较低&#xff0c;由于需要对法线贴图进行采样&a…

【区块链+金融服务】区块链在仓储融资的创新应用 | FISCO BCOS应用案例

释放数据要素价值&#xff0c;FISCO BCOS 2024 应用案例征集 在仓储融资业务中&#xff0c;对质押物的有效监管至关重要&#xff0c;但仓储融资一般涉及到监管方、仓储方和金融机构等多套系统&#xff0c; 金融机构的系统与仓储系统不直连&#xff0c;难以实时获取质押物库存情…

【YOLOv5/v7改进系列】替换Neck为Gold-Yolo特征融合网络

一、导言 Gold-YOLO是一种高效的物体检测模型&#xff0c;它通过一种新的机制——Gather-and-Distribute&#xff08;GD&#xff09;机制来增强多尺度特征融合的能力&#xff0c;从而在保证实时性能的同时提高了检测精度。下面是对Gold-YOLO的主要特点和创新点的概述&#xff…

谈一谈TVM编译工程师的修炼手册

首先提一下TVM TVM 被称为编译器&#xff0c;是因为它在深度学习模型的优化和执行过程中执行了类似传统编译器的许多工作。与传统编译器将高级语言代码&#xff08;如 C&#xff09;编译为机器代码类似&#xff0c;TVM 将深度学习模型表示&#xff08;如 ONNX&#xff09;转化…

深度相机,通过2d检测得到目标坐标系的3d检测框

算法流程图如下 1. 输入同步&#xff1a; 订阅三个主题&#xff1a; 深度图像 (depth_image)。相机信息 (depth_info)。2D目标检测 (detections)。 使用 message_filters.ApproximateTimeSynchronizer 来同步这些输入&#xff0c;以确保处理的消息是对应的。 2. 计算2D边界…

GET新知识-如何通过Ubuntu和Windows进行文件交互

知识记录篇改求助篇了呜呜呜~~~ &#xff0c;到最后一步passwd咋样都无法链接了。 1.通过下载open SSH进行交互 输入Linux命令: sudo apt install openssh-server 然后就会出现这个&#xff0c;输入Y确认&#xff0c;即可安装成功 2.在Windows上也安装open SSH&#xff0c;具体…

CAN总线详解-理论知识部分

目录 CAN总线简介 CAN总线硬件电路 CAN电平标准 CAN收发器 ​编辑 CAN物理层特性 CAN总线帧格式 数据帧 数据帧格式 数据帧发展历史 遥控帧 错误帧 过载帧 帧间隔 位填充 波形实例 CAN总线接收方数据采样 接收方数据采样遇到的问题 位时序 硬同步 再同步 波…

月销量不足1000的新能源车,都是什么人在买?

近日&#xff0c;盐城经济技术开发区人民法院决定受理高合汽车母公司华人运通&#xff08;江苏&#xff09;技术有限公司预重整申请。 由此&#xff0c;高合汽车正式破产重整。无独有偶&#xff0c;恒大汽车附属公司广东恒大新能源汽车和智能汽车也被申请破产重整。 高合和恒…

使用API有效率地管理Dynadot域名,对拍卖的域名进行出价

前言 Dynadot是通过ICANN认证的域名注册商&#xff0c;自2002年成立以来&#xff0c;服务于全球108个国家和地区的客户&#xff0c;为数以万计的客户提供简洁&#xff0c;优惠&#xff0c;安全的域名注册以及管理服务。 Dynadot平台操作教程索引&#xff08;包括域名邮箱&…

python实现每天定时发送邮件

文章目录 步骤 1: 安装所需的库步骤 2: 编写发送电子邮件的 Python 脚本步骤 3: 配置电子邮件发送服务步骤 4: 运行脚本进一步扩展 要编写一个用于自动发送每日电子邮件报告的 Python 脚本&#xff0c;并配置它在每天的特定时间发送电子邮件&#xff0c;使用 smtplib 和 emai…

高可用集群keepalived的应用以及部署

1.高可用集群 1.1.集群类型 LB&#xff1a;Load Balance 负载均衡 LVS/haproxy/nginx&#xff08;http/upstream,stream/upstream&#xff09; HA : High Point of Failure 高可用集群 数据库、Redis SPoF&#xff1a;single point Of failure 解决单点故障 HPC&#xff1a;…

数据库管理-第228期 Oracle全球分布式数据库-初探(20240812)

数据库管理228期 2024-08-12 数据库管理-第228期 Oracle全球分布式数据库-初探&#xff08;20240812&#xff09;1 概念2 关于全球分布式数据库3 分布式分区4 Oracle全球分布式数据库的优势总结 数据库管理-第228期 Oracle全球分布式数据库-初探&#xff08;20240812&#xff0…

如何在Shopify开发中高度还原Figma设计稿

### 一、理解设计意图&#xff1a;设计与开发的有效沟通#### 1. 早期沟通的重要性在开发工作开始之前&#xff0c;开发人员应与设计师进行详细的沟通&#xff0c;确保对设计意图有深刻理解。关键点包括&#xff1a;- **色彩和字体**&#xff1a;了解设计师对品牌色彩和字体的选…

从0开始搭建vue + flask 旅游景点数据分析系统(十一):登录、注册页面、未登录拦截、注销逻辑

这一期已经到了系列教程的尾声了&#xff0c;下面来搭建登录、注册页面&#xff0c;处理登录拦截和注销的逻辑 1 建表 先把数据库表用户相关的数据库表建立一下&#xff1a; CREATE TABLE tb_user (id int NOT NULL AUTO_INCREMENT COMMENT id,realname varchar(255) CHARAC…

燃气综合管理解决方案:构建安全可靠的燃气供应网络

无论是繁华的都市中心还是宁静的郊区&#xff0c;地下深处都隐藏着错综复杂的燃气管道网络&#xff0c;这些管网为千家万户输送着生活必需的能源。尽管这些管道由高强度和耐腐蚀材料制成&#xff0c;但长期暴露于自然环境中仍会逐渐老化和磨损。一旦发生破损或因人为错误导致管…

eNSP 华为单臂路由实现VLAN间通信

华为单臂路由实现VLAN间通信 SW&#xff1a; <Huawei>sys <Huawei>system-view [Huawei]sysname SW [SW]VLAN batch 10 20 //批量划分VLAN [SW]int g0/0/1 [SW-GigabitEthernet0/0/1]port link-type trunk [SW-GigabitEthernet0/0/1]port trunk allow-pa…