IDEA:Dangling Javadoc comment

JetBrains对JavaDocs的描述:

Javadoc comments are usually placed above classes, methods, or fields in your source code. A Javadoc provides a description of the code element located under it and contains block tags marked with @ with specific metadata.

You can generate an API reference for your project in HTML by using the Javadoc tool that comes with your JDK. IntelliJ IDEA provides integration with the tool and allows you to build reference guides right from the IDE.

Learn more about the correct format of Javadocs, style guide, terms and conventions from How to Write Doc Comments for the Javadoc Tool.

关闭对JavaDoc comment的告警路径如下,将对号去掉即可:

相关推荐
你我约定有三3 分钟前
spring--xml注入时bean的property属性
xml·java·spring
小雪_Snow4 分钟前
正则表达式
java
Codebee4 分钟前
OneCode 3.0 VFS客户端驱动(SDK)技术解析:从架构到实战
java·后端·架构
喜欢敲代码的程序员42 分钟前
Spring Boot中请求参数读取方式
java·spring boot·后端·spring
杜莱1 小时前
IDEA 安装AI代码助手GitHub Copilot和简单使用体验
人工智能·github·intellij-idea
唐不是营养物质1 小时前
Apache POI 的 HSSFWorkbook、SXSSFWorkbook和XSSFWorkbook三者的区别
java
Hy行者勇哥1 小时前
在 JetBrains 系列 IDE(如 IntelliJ IDEA、PyCharm 等)中如何新建一个 PlantUML 文件
ide·pycharm·intellij-idea
pk_xz1234561 小时前
在Intel Mac的PyCharm中设置‘add bin folder to the path‘的解决方案
ide·人工智能·科技·算法·macos·pycharm·机器人
樽酒ﻬق2 小时前
Prometheus Operator:Kubernetes 监控自动化实践
java·算法·云原生·运维开发
有梦想的攻城狮2 小时前
快速搭建Maven仓库服务
java·maven·仓库·nexus