# 将 Sonar 行尾注释改为 Javadoc 注释
在现代软件开发中，代码注释是一个不可或缺的部分。不仅可以帮助其他开发者理解代码逻辑，还可以提高代码维护的效率。Sonar 是一款常用的代码质量检查工具，它会分析代码并给出优化建议。如果你在代码中使用了行尾注释，Sonar 可能会提示你需要将它们转换为 Javadoc 注释。本文将深入探讨如何进行这种转换，并提供相关的代码示例。
## 什么
# Java 行尾注释的使用与解析
在编程中，注释是提升代码可读性的重要组成部分。Java 编程语言中，行尾注释是最常见的一种注释形式。它们帮助开发人员理解代码的意图，记录重要的信息，以及在代码复审和维护过程中提供相应的上下文。本文将对 Java 的行尾注释进行解析，并通过简单的代码示例和辅助图表来展示其重要性。
## 什么是行尾注释
在 Java 中，行尾注释是使用双斜杠 `//` 来表示
原创
2024-09-04 06:07:57
106阅读
简单记录，Java 核心技术卷I 基础知识（原书第10 版）注释我们在编写程序时，经常需要添加一些注释，用来描述某段代码的作用，提高Java源程序代码的可读性，使得Java程序条理清晰。写代码的时候应遵循注意一些java规范，函数短小精悍，用清晰的命名来解释代码， 整洁的代码， 不要保留不用的代码（注释代码），要么删掉，要么想到更好的方案替换，别留着，注释不要写废话和错误的。那为什么要写注释呢？在
转载
2024-10-24 10:13:58
43阅读
onarQube是管理代码质量一个开放平台，可以快速的定位代码中潜在的或者明显的错误，下面将会介绍一下这个工具的安装、配置以及使用。准备工作；1、jdk（不再介绍）2、sonarqube：http://www.sonarqube.org/downloads/3、SonarQube+Scanner:https://sonarsource.bintray.com/Distribution/sonar-
转载
2024-10-15 06:41:26
77阅读
在Java编程中，行尾注释往往是不被推荐使用的。这是因为行尾注释在某些情况下可能导致代码可读性下降，特别是当代码行较长时，注释内容可能被严重压缩，影响开发者对代码的理解。下面将详细探讨“Java为什么不建议使用行尾注释”的问题，以帮助大家更好地理解这个技术定位。
> **引用**
> “可读性是代码质量的重要因素。过多的行尾注释可能导致代码难以维护。”——著名开发者实用性编程原则
```m
1、alt + 鼠标左键 可以选取矩形代码区域 2、 在idea中代码块多个异常添加try/catch的快捷键，选中想被try/catch包围的语句， 同时按下ctrl+alt+t， 出现下图 ，选择你需要的即可； 3、多行注释:ctrl+shift+/4、在实体类中插入get、set等方法，Alt + Insert.5、选中一段代码，Ctrl + Shift + Y，变为全大写。6、选中一段代码
转载
2024-04-03 12:27:45
1140阅读
grep ^[^\#] kingbase.conf | sed 's/#.*//' | sed '/^\s*$/d' ...
转载
2021-11-01 11:45:00
178阅读
2评论
运行之前的系统，代码中一堆的黄色波浪线。看起来很闹心。查了一下原因，使用了阿里规范插件导致的。但是老系统全部改的话，又不太现实，只能修改配置，屏蔽掉这个行尾注释的提示。
原创
2023-06-10 05:41:09
369阅读
Settings -> Inspections -> 注释 取消 “方法内部单行注释 xxxx ” 里面的勾，【设完后重启】如下图
原创
2022-12-23 01:33:47
608阅读
javadoc 标记是插入文档注释中的特殊标记，它们用于标识代码中的特殊引用。javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成。三个部分——@、标记类型、专用注释引用。可以分成两部分：@ 和标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔，但是最好始终将它们紧挨着写，以减少出错机会。这些是注释类，属性和方法的。 简述是注释的第一个‘.’之前的所有内容。jav
转载
2023-06-15 20:46:55
587阅读
javaDoc代码注释基本规范代码注释是架起程序设计者与程序阅读者之间的通信桥梁，最大限度的提高团队开发合作效率。也是程序代码可维护性的重要环节之一。所以我们不是为写注释而写注释。原则：1、注释形式统一在整个应用程序中，使用具有一致的标点和结构的样式来构造注释。如果在其它项目中发现它们的注释规范与这份文档不同，按照这份规范写代码，不要试图在既成的规范系统中引入新的规范。2、注释内容准确简洁内容要简
转载
2023-08-28 14:50:46
173阅读
前言： 如果在源代码中添加以专用的定界符/**开始的注释，那么可以很容易地生成一个具有专业水准的文档。 注释应该放置在所描述特性的前面。注释以/** 开始，并以*/结束。 文档注释：第一段：概要描述，通常用一句或者一段话简要描述该类的作用，以英文句号作为结束第二段：详细描述，通常用一段或者多段话来详细描述该类的作用，一般每段话都以英文句号作为结束第三段：文档标注，用于
转载
2024-02-02 09:58:46
110阅读
前言
Java 的语法与 C++ 及为相似，那么，你知道 Java 的注释有几种吗？是两种？ // 注释一行 /* ...... */ 不完全对，除了以上两种之外，还有第三种，文档注释： /** ...... */ 通常这种注释的多行写法如下： /** * ......... * ......... */ 暂停，暂停！这第三种注释有什么用？j
转载
2023-09-06 19:09:07
84阅读
简介Javadoc用于描述类或者方法的作用。Javadoc可以写在类上面和方法上面。很多程序对Javadoc都不重视，认识不到Javadoc的作用，很多人都是这样认为的：“我只要写好功能就够了，写Javadoc太浪费时间，也没啥作用，还不如用写Javadoc的时间再多些个功能呢！”，我们知道注释是为了解释代码的作用的，是为了将来给自己或者别人快速了解代码的，在方法内一般用行注释//的比较多，是针对
转载
2024-06-20 12:51:43
102阅读
最近听到很多做程序员的小伙伴儿吐槽：从别人那儿接手的代码总是乱糟糟的，完全不知道写的什么！没有标记，没有说明，也没有一行注释，抓耳挠腮也看不懂！ 前程序员辞职留下的代码，谁也不愿意接手这个时候，就需要万能的“注释”大大了！所谓注释，便是用自然语言对源代码中某些语句或方法进行说明。并且，注释的内容不会被编译器编译。你可以在源代码中添加任何你想要添加的说明，随便多少都可以，只要你不觉得啰嗦
转载
2023-08-20 00:14:48
113阅读
qiyadeng 前言 Java 的语法与 C++ 及为相似，那么，你知道 Java 的注释有几种吗？是两种？ // 注释一行 /* ...... */ 注释若干行 不完全对，除了以上两种之外，还有第三种，文档注释： /** ...... */ 注释若干行，并写入 javadoc 文档 通常这种注释的多行写法如下： /** * ......... * .....
转载
2023-09-06 19:46:27
142阅读
Java语言的注释：单行注释 // +注释内容 多行注释 /* +注释内容 */ 文档注释 /** +注释内容 */ PS：JDK可通过javadoc工具直接将源代码里面的文档注释提取成一份系统的API文档 补充javadoc命令的基本用法：javadoc -d<directory>：选择指定的一个路径，用于将生成的API文档放到指定路径下 javadoc -windowtitl
转载
2024-04-09 06:47:58
42阅读
所有javadoc命令都只能出现于“/**”注释中。但和平常一样，注释结束于一个“*/”。主要通过两种方式来使用javADOc：嵌入的html，或使用“文档标记”。其中，“文档标记”(Doc tags)是一些以“@”开头的命令，置于注释行的起始处(但前导的“*”会被忽略)。有三种类型的注释文档，它们对应于位于注释后面的元素：类、变量或者方法。也就是说，一个类注释正好位于一个类定义之前;变量注释正好
转载
2023-08-20 00:13:12
202阅读
这是我学习java的笔记，主要记录java特有的知识点。1.注释1)单行注释，使用双斜杠“//注释部分”，与C/C++一样。2)多行注释，“”，与C/C++一样。3)doc注释，，这是Java特有的注释，以“”结尾。这种注释主要是为了支持JDK工具Javadoc而采用的。Javadoc能识别注释中用标记@标识的一些特殊变量，并把doc注释加入它所生成的HTML文件中。2.标识符Java的标识符以字
转载
2023-09-20 17:29:51
92阅读
Java注释是Java代码文件中被编译器和运行时引擎忽略的注释。它们用于对代码进行注释，以澄清其设计和用途。你可以向Java文件中添加无限数量的注释，但是在使用注释时有一些“最佳实践”需要遵循。通过优锐课的java学习分享中，我们可以看到关于使用java注释的详细解说，分享给大家参考学习。通常，代码注释是解释源代码，例如对类、接口、方法和字段的描述。这些通常是写在Java代码上面或旁边的几行代码，
转载
2023-09-01 14:09:02
72阅读
