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

【Java SE】代码注释

news 2026/5/13 3:54:28

代码注释

注释（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

MegaParse：一站式文档解析库的设计原理与工程实践

1. 项目概述&#xff1a;从“MegaParse”看文档解析的“大”与“全”在信息爆炸的时代&#xff0c;我们每天都要处理海量的文档——PDF报告、Word合同、Excel表格、PPT演示稿&#xff0c;甚至网页截图和扫描件。对于开发者、数据分析师和知识管理从业者来说&#xff0c;如何将这…...

编程新知 2026/5/13 3:07:42

Go语言构建高效命令行工具集：从设计到工程化实践

1. 项目概述&#xff1a;一个“好用的”开源工具集最近在GitHub上闲逛&#xff0c;发现了一个挺有意思的仓库&#xff0c;叫ImGoodBai/goodable。光看这个名字&#xff0c;就透着一股子“实用主义”的气息——“好用的”。作为一名常年混迹于开源社区&#xff0c;喜欢折腾各种工…...

编程新知 2026/5/13 2:11:22

GitHub加速终极指南：3步让你的下载速度提升10倍！

GitHub加速终极指南&#xff1a;3步让你的下载速度提升10倍&#xff01; 【免费下载链接】Fast-GitHub 国内Github下载很慢&#xff0c;用上了这个插件后&#xff0c;下载速度嗖嗖嗖的~&#xff01; 项目地址: https://gitcode.com/gh_mirrors/fa/Fast-GitHub 还在为Git…...

编程新知 2026/5/13 1:50:10

DeepSeek（V3为主、兼顾V2/R1）算力优化细节详解

DeepSeek&#xff08;V3为主、兼顾V2/R1&#xff09;算力优化细节详解以下是针对核心优化模块的深入技术拆解&#xff0c;包含MLA数学原理、FP8精准实现、无辅助损失负载均衡、R1-GRPO算法核心&#xff0c;内容基于DeepSeek-V3官方技术报告及2026年5月公开权威分析。DeepSeek系…...

编程新知 2026/5/13 0:12:12

从规范到验证：构建企业级环境变量与密钥安全管理体系

1. 项目概述&#xff1a;从“裸奔”到“装甲车”的密钥管理进化在开发一个现代应用时&#xff0c;我们几乎不可避免地要和一堆敏感信息打交道&#xff1a;数据库密码、API密钥、第三方服务的访问令牌、加密盐值……这些信息&#xff0c;我们通常称之为“环境变量”或“密钥”。…...

编程新知 2026/5/13 0:08:10

基于官方API的WhatsApp AI助手集成：规避封号风险与实战部署指南

1. 项目概述&#xff1a;为你的AI助手开通一个安全的WhatsApp专线 如果你正在使用OpenClaw构建自己的AI助手&#xff0c;并且希望它能通过WhatsApp与用户自然交流&#xff0c;那么你很可能已经研究过各种方案了。市面上常见的方案&#xff0c;比如基于 whatsapp-web.js 或 …...

编程新知 2026/5/12 23:23:17

Midjourney v7新功能全维度压测报告（v6 vs v7实测对比：提示词容错率↑47%，构图理解准确率突破92.6%）

更多请点击&#xff1a; https://intelliparadigm.com 第一章&#xff1a;Midjourney v7新功能全面解析 Midjourney v7 于2024年第三季度正式发布&#xff0c;标志着AI图像生成在语义理解、构图控制与跨模态一致性方面迈入新阶段。本次升级不再仅依赖提示词&#xff08;prompt…...

编程新知 2026/5/12 22:25:07

CoverM如何革新宏基因组覆盖率分析：从短读长到PacBio HiFi的完整解决方案

CoverM如何革新宏基因组覆盖率分析&#xff1a;从短读长到PacBio HiFi的完整解决方案 【免费下载链接】CoverM Read alignment statistics for metagenomics 项目地址: https://gitcode.com/gh_mirrors/co/CoverM 宏基因组研究正经历着从短读长测序到长读长技术的深刻变…...

编程新知 2026/5/12 22:07:05

“枯笔”“泼墨”“留白”在Midjourney中根本不存在？——资深数字书画师拆解6个被长期误用的东方美学关键词

更多请点击&#xff1a; https://intelliparadigm.com 第一章&#xff1a;东方美学与AI绘图的本质断层 气韵生动与像素采样的不可通约性 东方绘画传统以“气韵生动”为最高准则&#xff0c;强调笔意流转、留白呼吸、时间性观照与心手相忘的即兴生成。而当前主流AI绘图模型&am…...

编程新知 2026/5/12 21:37:48

iOS越狱防火墙ijfw：从网络流量监控到精细化应用管控实战

1. 项目概述与核心价值最近在折腾一个挺有意思的开源项目&#xff0c;叫ijfw&#xff0c;全称是iOS Jailbreak Firewall。顾名思义&#xff0c;这是一个专门为越狱后的iOS设备设计的防火墙工具。如果你和我一样&#xff0c;是个喜欢在iPhone上“折腾”的玩家&#xff0c;或者对…...

编程新知 2026/5/12 21:16:00