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

【Java SE】代码注释

代码注释

注释(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.javapackage.html两种方式)。注意:package-info.java文件必须包含一个初始的Javadoc注释,以/** */界定,后面是一个package语句,且不包含其他内容;package.html<body>...</body>之间的所有文本为注释内容。

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

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

其中,xxyy可以是authorversionJava doc标记,表示要生成的标记。

http://www.lryc.cn/news/472975.html

相关文章:

  • 如何在算家云搭建Llama3-Factory(智能对话)
  • 操作数据表
  • C# 实现进程间通信的几种方式(完善)
  • MySQL Workbench Data Import Wizard:list index out of range
  • 微信支付宝小程序SEO优化的四大策略
  • AutoDIR: Automatic All-in-One Image Restoration with Latent Diffusion论文阅读笔记
  • SQLite 数据库设计最佳实践
  • 【论文精读】ID-like Prompt Learning for Few-Shot Out-of-Distribution Detection
  • Android 10.0 根据包名禁用某个app的home事件
  • Rust 文档生成与发布
  • 【C++动态规划】有效括号的嵌套深度
  • 2024年优秀的天气预测API
  • Android和iOS有什么区别?
  • NVR小程序接入平台/设备EasyNVR多个NVR同时管理多平台级联与上下级对接的高效应用
  • Spring Cloud Sleuth(Micrometer Tracing +Zipkin)
  • 人工智能:机遇与挑战
  • mac电脑设置crontab定时任务,以及遇到的问题解决办法
  • Backtrader 数据篇 02
  • 视频转场素材资源网站分享
  • 二十二、MySQL 8.0 主从复制原理分析与实战
  • 基于OSS搭建在线教育视频课程分享网站
  • CentOS 7 下升级 OpenSSL
  • 线上 Dump
  • AcWing 1303:斐波那契前 n 项和 ← 矩阵快速幂加速递推
  • 2024 Rust现代实用教程:1.2编译器与包管理工具以及开发环境搭建
  • 人工智能原理实验一:知识的表示与推理实验
  • 自学C语言——VS实用调试技巧总结
  • VC2012创建弹出式菜单
  • Google 第三季度季报出炉
  • 入职总结(更新中)