当前位置： 首页 > news >正文

【Java SE】代码注释

news 文章来源：https://blog.csdn.net/zzy_NIC/article/details/143374803 2025/1/9 1:50:24

代码注释

注释（comment）是用于说明解释程序的文字，注释的作用在于提高代码的阅读性（可读性）。Java中的注释类型包括3种，分别是：

  • 单行注释
  • 多行注释
  • 文档注释

❤️ 单行注释

基本格式：// 注释文字

// Comment

💙 多行注释

基本格式：/* 注释文字 */

使用细节：多行注释里面不允许多行注释嵌套！

/*Comment...*/

💚 文档注释

类型说明：注释内容可以被JDK提供的javadoc所解析，生成一套以网页文件形式体现的程序说明文档。

/*** @author xxx* @version 1.0* Doc Comment*/

基本格式：每个/** */文档注释包含标记以及之后紧跟着的自由格式文本（free-form text）。标记以@开头，自由格式文本用于描述，可以使用HTML修饰符，比如用于强调的<em>...</em>。

使用细节：没有必要在每行开始都添加*，不过大部分IDE会自动提供*。

/**@author xxx@version 1.0Doc Comment*/

使用过程：

  • 类注释：必须方在import语句之后，class定义之前。

  • 方法注释：必须放在所描述的方法之前，除通用标记外，还有@param、@return和@throws。

  • 字段注释：只需对公共字段（通常指静态常量）添加文档注释。

  • 通用注释：包括@since、@author、@version、@see和@link（@see和@link可以使用超链接）。

  • 包注释：需要在每个包目录中添加单独的文件（有package-info.java和package.html两种方式）。注意：package-info.java文件必须包含一个初始的Javadoc注释，以/** */界定，后面是一个package语句，且不包含其他内容；package.html中<body>...</body>之间的所有文本为注释内容。

注释提取：将生成的网页文件放在指定文件夹下

javadoc -d 文件夹名 -xx -yy demo.java

其中，xx和yy可以是author、version等Java doc标记，表示要生成的标记。

相关文章：

【Java SE】代码注释

代码注释 注释&#xff08;comment&#xff09;是用于说明解释程序的文字&#xff0c;注释的作用在于提高代码的阅读性&#xff08;可读性&#xff09;。Java中的注释类型包括3种&#xff0c;分别是&#xff1a; 单行注释多行注释文档注释 ❤️ 单行注释 基本格式&#xff…...

编程日记 2024/10/31 8:27:12

如何在算家云搭建Llama3-Factory（智能对话）

一、Llama3-Factory 简介 当地时间 4 月 18 日&#xff0c;Meta 在官网上宣布公布了旗下最新大模型 Llama 3。目前&#xff0c;Llama 3 已经开放了 80 亿&#xff08;8B&#xff09;和 700 亿&#xff08;70B&#xff09;两个小参数版本&#xff0c;上下文窗口为 8k。Llama3 是…...

编程日记 2024/10/31 8:25:10

操作数据表

创建表 创建表语法&#xff1a; CREATE TABLE table_name ( field1 datatype [COMMENT 注释内容], field2 datatype [COMMENT 注释内容], field3 datatype ); 注意&#xff1a; 1. 蓝色字体为关键字 2. CREATE TABLE 是创建数据表的固定关键字&#xff0c;表…...

编程日记 2024/10/31 8:23:08

C# 实现进程间通信的几种方式（完善）

目录 引言 一、基本概念 二、常见的IPC方法 1. 管道&#xff08;Pipes&#xff09; 2. 共享内存&#xff08;Shared Memory&#xff09; 3. 消息队列&#xff08;Message Queues&#xff09; 4. 套接字&#xff08;Sockets&#xff09; 5. 信号量&#xff08;Semaphore…...

编程日记 2024/10/31 8:21:05

MySQL Workbench Data Import Wizard:list index out of range

MySQL Workbench的Data Import Wizard功能是用python实现的&#xff0c;MySQL Workbench自带了一个python&#xff0c;数据导入的时候出现错误提示 22:55:51 [ERR][ pymforms]: Unhandled exception in Python code: Traceback (most recent call last): File "D…...

编程日记 2024/10/31 8:19:02

微信支付宝小程序SEO优化的四大策略

在竞争激烈的小程序市场中&#xff0c;高搜索排名意味着更多的曝光机会和潜在用户。SEO即搜索引擎优化&#xff0c;对于小程序而言&#xff0c;主要指的是在微信小程序商店中提高搜索排名&#xff0c;从而增加曝光度和用户访问量。有助于小程序脱颖而出&#xff0c;提升品牌知名…...

编程日记 2024/10/31 8:16:59

AutoDIR: Automatic All-in-One Image Restoration with Latent Diffusion论文阅读笔记

AutoDIR: Automatic All-in-One Image Restoration with Latent Diffusion 论文阅读笔记 这是ECCV2024的论文&#xff0c;作者单位是是港中文和上海AI Lab 文章提出了一个叫AutoDIR的方法&#xff0c;包括两个关键阶段&#xff0c;一个是BIQA&#xff0c;基于vision-language…...

编程日记 2024/10/31 8:14:56

SQLite 数据库设计最佳实践

SQLite特点 SQLite是一款功能强大的 轻量级嵌入式数据库 ，具有以下显著特点： 体积小 ：最低配置仅需几百KB内存，适用于资源受限环境。 高性能 ：访问速度快，运行效率高于许多开源数据库。 高度可移植 ：兼容多种硬件和软件平台。 零配置 ：无需复杂设置，开箱即用。 自给自…...

编程日记 2024/10/31 8:13:55

【论文精读】ID-like Prompt Learning for Few-Shot Out-of-Distribution Detection

&#x1f308; 个人主页&#xff1a;十二月的猫-CSDN博客 &#x1f525; 系列专栏&#xff1a; &#x1f3c0;论文精读_十二月的猫的博客-CSDN博客 &#x1f4aa;&#x1f3fb; 十二月的寒冬阻挡不了春天的脚步&#xff0c;十二点的黑夜遮蔽不住黎明的曙光 注&#xff1a;下文…...

编程日记 2024/10/31 8:10:52

Android 10.0 根据包名禁用某个app的home事件

1.前言 在10.0的系统rom定制化开发中，在某些app中，需要禁用home事件，在普通的app中又无法 禁用home事件，所以就需要从系统中来根据包名禁用home事件了，接下来分析下 系统中处理home事件的相关流程 2.根据包名禁用某个app的home事件的核心类 frameworks/base/services/c…...

编程日记 2024/10/31 8:08:50

Rust 文档生成与发布

目录 第三节 文档生成与发布 1. 使用 RustDoc 生成项目文档 1.1 RustDoc 的基本使用 1.2 文档注释的格式与实践 1.3 生成文档的其他选项 1.4 在 CI/CD 中生成文档 2. 发布到 crates.io 的步骤与注意事项 2.1 创建 crates.io 账户 2.2 配置 Cargo.toml 2.3 生成发布版…...

编程日记 2024/10/31 8:07:49

【C++动态规划】有效括号的嵌套深度

本文涉及知识点 C动态规划 LeetCode1111. 有效括号的嵌套深度 有效括号字符串 定义&#xff1a;对于每个左括号&#xff0c;都能找到与之对应的右括号&#xff0c;反之亦然。详情参见题末「有效括号字符串」部分。 嵌套深度 depth 定义&#xff1a;即有效括号字符串嵌套的层…...

编程日记 2024/10/31 8:04:46

2024年优秀的天气预测API

准确、可操作的天气预报对于许多组织的成功至关重要。 事实上&#xff0c;在整个行业中&#xff0c;天气条件会直接影响日常运营&#xff0c;包括航运、按需、能源和供应链&#xff08;仅举几例&#xff09;。 以公用事业为例。根据麦肯锡的数据&#xff0c;在 1.4 年的时间里…...

编程日记 2024/10/31 8:03:45

Android和iOS有什么区别？

Android 和 iOS 有以下区别&#xff1a; 开发者与所属公司&#xff1a; Android&#xff1a;由谷歌公司开发以及开放手机联盟维护。它是基于 Linux 内核和其他开源软件的修改版本&#xff0c;代码开源程度较高&#xff0c;许多厂商都可以基于 Android 源代码进行深度定制和开发…...

编程日记 2024/10/31 8:02:44

NVR小程序接入平台/设备EasyNVR多个NVR同时管理多平台级联与上下级对接的高效应用

政务数据共享平台的建设正致力于消除“信息孤岛”现象&#xff0c;打破“数据烟囱”&#xff0c;实现国家、省、市及区县数据的全面对接与共享。省市平台的“级联对接”工作由多级平台共同构成&#xff0c;旨在满足跨部门、跨层级及跨省数据共享的需求&#xff0c;推动数据流通…...

编程日记 2024/10/31 8:00:42

Spring Cloud Sleuth（Micrometer Tracing +Zipkin）

分布式链路追踪 分布式链路追踪技术要解决的问题&#xff0c;分布式链路追踪&#xff08;Distributed Tracing&#xff09;&#xff0c;就是将一次分布式请求还原成调用链路&#xff0c;进行日志记录&#xff0c;性能监控并将一次分布式请求的调用情况集中展示。比如各个服务节…...

编程日记 2024/10/31 7:59:41

人工智能：机遇与挑战

人工智能&#xff08;AI&#xff09;作为当今世界科技发展的前沿领域&#xff0c;正在以前所未有的速度和规模影响着我们的生活和工作方式。AI技术的应用前景广阔&#xff0c;从医疗健康到金融服务&#xff0c;从教育到交通&#xff0c;再到娱乐和家庭生活&#xff0c;AI正在逐…...

编程日记 2024/10/31 7:57:39

mac电脑设置crontab定时任务，以及遇到的问题解决办法

crontab常用命令 crontab -u user&#xff1a;用来设定某个用户的crontab服务&#xff1b; crontab file&#xff1a;file是命令文件的名字,表示将file做为crontab的任务列表文件并载入crontab。如果在命令行中没有指定这个文件&#xff0c;crontab命令将接受标准输入&#xf…...

编程日记 2024/10/31 7:51:33

Backtrader 数据篇 02

Backtrader 数据篇 本系列是使用Backtrader在量化领域的学习与实践&#xff0c;着重介绍Backtrader的使用。Backtrader 中几个核心组件&#xff1a; Cerebro&#xff1a;BackTrader的基石&#xff0c;所有的操作都是基于Cerebro的。Feed&#xff1a;将运行策略所需的基础数据…...

编程日记 2024/10/31 7:47:28

视频转场素材资源网站分享

视频剪辑者常常为找不到合适的转场素材而苦恼。合适的转场素材能让视频更流畅&#xff0c;给观众带来惊喜。下面就为大家介绍几个宝藏网站&#xff0c;提供丰富的转场剪辑素材&#xff0c;让你的视频瞬间高大上。 蛙学网 首先重磅推荐蛙学网&#xff0c;堪称视频素材界的“翘楚…...

编程日记 2024/10/31 7:45:26

二十二、MySQL 8.0 主从复制原理分析与实战

文章目录 一、复制&#xff08;Replication&#xff09;1、什么是复制2、复制的方式3、复制的数据同步类型3.1、异步复制3.2、半同步复制3.3、设计理念&#xff1a;复制状态机——几乎所有的分布式存储都是这么复制数据的 4、基于binlog位点同步的主从复制原理4.1、异步复制示例…...

编程日记 2024/10/31 7:42:22

基于OSS搭建在线教育视频课程分享网站

OSS对象存储服务是海量、安全、低成本、高持久的存储服务。适合于存储大规模非结构化数据&#xff0c;如图片、视频、备份文件和容器/虚拟机镜像等。 安装nginx wget https://nginx.org/download/nginx-1.20.2.tar.gz yum -y install zlib zlib-devel gcc-c pcre-devel open…...

编程日记 2024/10/31 7:35:15

CentOS 7 下升级 OpenSSL

升级openssh,下载&#xff1a;https://download.csdn.net/download/weimeilayer/89935114 上传到服务器&#xff0c;然后执行命令 rpm -Uvh *.rpm --nodeps --force安装依赖 yum -y install gcc perl make zlib-devel perl-CPAN下载安装包&#xff1a;https://github.com/ope…...

编程日记 2024/10/31 7:30:10

线上 Dump

优质博文&#xff1a;IT-BLOG-CN 一、简介 机器宕机或者请求很慢最常出现的几种问题&#xff1a;针对代码bug或者qps过高造成的。 【1】cpu过高致内存耗尽OOM&#xff0c;堆区对象回收不及时cpu被打满 【2】死锁抢用资源导致cpu过高致耗尽 【3】内存泄漏&#xff1a; 堆内存由…...

编程日记 2024/10/31 7:26:05

AcWing 1303：斐波那契前 n 项和 ← 矩阵快速幂加速递推

【题目来源】https://www.acwing.com/problem/content/1305/http://poj.org/problem?id3070【题目描述】 大家都知道 数列吧&#xff0c;。现在问题很简单&#xff0c;输入 和 &#xff0c;求 的前 项和 。【输入格式】 共一行&#xff0c;包含两个整数 和 。【输出格式】…...

编程日记 2024/10/31 7:24:58

2024 Rust现代实用教程：1.2编译器与包管理工具以及开发环境搭建

文章目录 一、Rust的编译器rustc二、开发环境搭建三、Rust的包管理工具Cargo四、项目结构1.Cargo.toml文件2.创建一个可执行文件项目3.创建一个库项目 参考 一、Rust的编译器rustc 查看版本 rustc-version编译生成二进制文件 rustc -o output filename filename.rs编译生成库…...

编程日记 2024/10/31 7:23:57

人工智能原理实验一：知识的表示与推理实验

一、实验目的 本实验课程是计算机、智能、物联网等专业学生的一门专业课程&#xff0c;通过实验&#xff0c;帮助学生更好地掌握人工智能相关概念、技术、原理、应用等&#xff1b;通过实验提高学生编写实验报告、总结实验结果的能力&#xff1b;使学生对智能程序、智能算法等有…...

编程日记 2024/10/31 7:19:53

自学C语言——VS实用调试技巧总结

接上一篇&#xff1a;自学C语言——扫雷游戏&#xff08;无递归&#xff09; 什么是bug “bug”本意是昆虫或虫子&#xff0c;一般指电脑系统或程序中&#xff0c;隐藏着一些未被发现的缺陷或者问题&#xff0c;简称程序漏洞。 第一代的计算机是由许多庞大且昂贵的真空管组成&…...

编程日记 2024/10/31 7:05:38

VC2012创建弹出式菜单

首先为视类添加鼠标右键单击处理函数&#xff0c;添加如下代码&#xff0c; void CMFCApplication1View::OnRButtonDown(UINT nFlags, CPoint point) {// TODO: 在此添加消息处理程序代码和/或调用默认值CView::OnRButtonDown(nFlags, point);CMenu menu;menu.CreatePopupMenu…...

编程日记 2024/10/31 7:04:36

Google 第三季度季报出炉

每周跟踪AI热点新闻动向和震撼发展 想要探索生成式人工智能的前沿进展吗&#xff1f;订阅我们的简报&#xff0c;深入解析最新的技术突破、实际应用案例和未来的趋势。与全球数同行一同&#xff0c;从行业内部的深度分析和实用指南中受益。不要错过这个机会&#xff0c;成为AI领…...

编程日记 2024/10/31 6:58:31

霸州网站建设/广告外链平台

开发项目过程中基本都会用到listView的下拉刷新和上滑加载更多&#xff0c;为了方便重写的ListView来实现下拉刷新&#xff0c;同时添加了上拉自动加载更多的功能。 Android下拉刷新可以分为两种情况&#xff1a; 1.获取更多的数据&#xff0c;按服务器数据库时间顺序存储入情况…...

编程日记 2025/1/9 1:30:26

青岛做门户网站的/怎么建立个人网站

IE&#xff1a;最好用的起始页(转)初上INTERNET&#xff0c;你的IE总是伴随着进度条那蜗牛般的爬行慢吞吞地打开它默认的起始页&#xff0c;这很浪费时间&#xff0c;即使你更换了起始页&#xff0c;它的速度也快不了&#xff0c;一般也不会用多长时间&#xff0c;许多上网的朋…...

编程日记 2025/1/8 23:23:32

中国做的很好的食品网站/网站制作平台

1. 插件kdb_flashback简介 插件kdb_flashback是KingbaseES 的一个扩展插件。主要功能是提供错误数据的快速恢复能力&#xff0c;目前提供的闪回技术包括闪回回收站&#xff0c;闪回查询&#xff0c;闪回版本查询&#xff0c;闪回到任意时间点。 插件名为 kdb_flashback 插件版…...

编程日记 2025/1/8 22:37:30

公司网站建设p开发/电商数据统计网站

穷人有穷人思维我们一点都不奇怪&#xff0c;但我见过很多老板也有穷人思维&#xff0c;这种思维说明一个什么问题&#xff1f;接下来我们就来看看为什么说有三种思想的人是当不了很大的老板的。思维一&#xff1a;你为我做多少事&#xff0c;我给你多少钱你给我干多少事&#…...

编程日记 2025/1/8 21:08:02

wordpress分类目录查不到文章/网络推广专员

一&#xff0c;自调用匿名函数 有两种方式: 第一种: (function(参数){....}(传入参数)) --->括号内的语句被强制执行 第二种: (function(参数){...})(传入参数) --->说明&#xff1a;jquery就是采用这种方式&#xff0c;这种方式的原理&#xff1a; 原来我们调用…...

编程日记 2025/1/8 18:03:48

佛山网站页面优化/今日国际军事新闻头条

转&#xff1a;http://www.imdsx.cn/index.php/2017/11/22/click/ 最近有很多同学私聊问我&#xff0c;在通过Selenium做UI自动化的时候&#xff0c;明明能够在DOM树内看到这个元素&#xff0c;但是我在通过driver click、sendkey的时候&#xff0c;就是点击不到或无法输入字符…...

编程日记 2025/1/8 12:19:51