简单记录，Java 核心技术卷I 基础知识（原书第10 版）注释我们在编写程序时，经常需要添加一些注释，用来描述某段代码的作用，提高Java源程序代码的可读性，使得Java程序条理清晰。写代码的时候应遵循注意一些java规范，函数短小精悍，用清晰的命名来解释代码， 整洁的代码， 不要保留不用的代码（注释代码），要么删掉，要么想到更好的方案替换，别留着，注释不要写废话和错误的。那为什么要写注释呢？在
转载
2024-10-24 10:13:58
43阅读
# Java 行尾注释的使用与解析
在编程中，注释是提升代码可读性的重要组成部分。Java 编程语言中，行尾注释是最常见的一种注释形式。它们帮助开发人员理解代码的意图，记录重要的信息，以及在代码复审和维护过程中提供相应的上下文。本文将对 Java 的行尾注释进行解析，并通过简单的代码示例和辅助图表来展示其重要性。
## 什么是行尾注释
在 Java 中，行尾注释是使用双斜杠 `//` 来表示
原创
2024-09-04 06:07:57
106阅读
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
1134阅读
# 将 Sonar 行尾注释改为 Javadoc 注释
在现代软件开发中，代码注释是一个不可或缺的部分。不仅可以帮助其他开发者理解代码逻辑，还可以提高代码维护的效率。Sonar 是一款常用的代码质量检查工具，它会分析代码并给出优化建议。如果你在代码中使用了行尾注释，Sonar 可能会提示你需要将它们转换为 Javadoc 注释。本文将深入探讨如何进行这种转换，并提供相关的代码示例。
## 什么
在Java编程中，行尾注释往往是不被推荐使用的。这是因为行尾注释在某些情况下可能导致代码可读性下降，特别是当代码行较长时，注释内容可能被严重压缩，影响开发者对代码的理解。下面将详细探讨“Java为什么不建议使用行尾注释”的问题，以帮助大家更好地理解这个技术定位。
> **引用**
> “可读性是代码质量的重要因素。过多的行尾注释可能导致代码难以维护。”——著名开发者实用性编程原则
```m
运行之前的系统，代码中一堆的黄色波浪线。看起来很闹心。查了一下原因，使用了阿里规范插件导致的。但是老系统全部改的话，又不太现实，只能修改配置，屏蔽掉这个行尾注释的提示。
原创
2023-06-10 05:41:09
369阅读
Settings -> Inspections -> 注释 取消 “方法内部单行注释 xxxx ” 里面的勾，【设完后重启】如下图
原创
2022-12-23 01:33:47
608阅读
grep ^[^\#] kingbase.conf | sed 's/#.*//' | sed '/^\s*$/d' ...
转载
2021-11-01 11:45:00
178阅读
2评论
本文章主要包括以下6个内容：一、注释分类以及javadoc的使用二、使用Alibaba Java Coding Guidelines规范编码。三、IDEA配置类注释四、IDEA配置方法注释====================正文开始====================一、注释分类以及javadoc的使用。 所谓注释就是只给人看的，而并不会被执行的语句。适当的代码注释可以提高代码
转载
2023-08-01 15:40:56
363阅读
这里设置的注释模板采用Eclipse的格式，下面先贴出Eclipse的注释模板，我们就按照这种格式来设置：类注释模板： 方法注释模板：一、首先我们来设置IDEA中类的模板：（IDEA中在创建类时会自动给添加注释）1、File–>settings–>Editor–>File and Code Templates–>Files我们选择Class文件（当然你要设置接口的还也可以
转载
2023-11-26 23:26:15
295阅读
IDEA 创建类注释模板和方法注释模板 在使用Idea的时候，它的注释模板很简单，不够详细；所有大多数开发者都想设置一个比较详细的注释模板，我现在把我了解的创建类注释模板和方法注释模板的操作记录下来，分享给大家
我们需要定义的注释模板如下：
类注释模板：类注释模板方法注释模板：方法注释模板一、设置IDEA 中的类注释模板
File -> Settings -> Editor ->
转载
2024-05-19 15:26:56
252阅读
idea 模版之自定义类与方法注释很多公司都有要求的代码注释规范，我们每新建类或者方法的时候从新复制粘贴很麻烦，而且容易粘错。当然自定义模板还可以用到很多地方，比如系统自带的 sout就是system.out.print(); 当你输入某文本的时候，系统会自动替换成目标文本。1定义java文件头部的注释2给java类中的方法添加上注释2.1第一步勾选Enable Live T
转载
2023-09-06 19:35:56
473阅读
## Java注释IDEA实现流程
在Java开发中，注释是一种非常重要的文档化工具，用于给代码添加说明和解释。在IDEA开发环境中，实现Java注释非常简单。下面我将详细介绍实现Java注释的具体步骤以及每一步所需的代码。
### 实现流程
下面是实现Java注释的流程：
```mermaid
gantt
title Java注释IDEA实现流程
section 创建J
原创
2023-10-20 03:35:37
42阅读
IDEA自带的注释模板不是太好用，我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家，我不是专业玩博客的，写这篇文章只是为了让大家省事。这里设置的注释模板采用Eclipse的格式，下面先贴出Eclipse的注释模板，我们就按照这种格式来设置：类注释模板： 方法注释模板： 一、首先我们来设置IDEA中类的模板：（IDEA中在创建类时会自动给添加注释）1、File–>
转载
2024-01-05 20:07:44
372阅读
开发过程中经常看到源码中的注释，感叹大佬的注释为何写得那么清新脱俗，决定简单研究一下IDEA中的注释众所周知，Java中的注释标识分为三种：// [1]
/* */ [2]
/** */ [3]第一种是单行注释 //之后的部分皆为注释 第二种和第三种注释可以将注释内容限制在斜杠之间，这是单行注释无法完成的public void setNameAndAge(/*名称*/Stri
转载
2023-09-25 11:40:13
257阅读
使用IDEA生成JavaDoc文档+自定义注解模板一、注释标签介绍二、IDEA生成JavaDoc文档2.1、IDEA选择`Tools`->`Generate JavaDoc`2.2、注意以下三个地方2.3、注意三、自定义注解模板3.1、注解在类上3.1.1图内模板3.2、注解在方法上3.2.1、`params`里的`脚本代码`3.2.2、图内模板 一、注释标签介绍标记说明标签类型@auth
转载
2023-07-21 22:34:20
574阅读
idea模板注释一、类注释二、方法注释三、测试效果 一、类注释打开 IDEA 的 Settings，点击 Editor–>File and Code Templates，点击右边 Files 选项卡下面的 Class，在其中添加图中红框内的内容:/**
* @Description ${Description}
* @Date ${YEAR}年${MONTH}月${DAY}日 ${TIM
转载
2023-09-27 09:02:21
841阅读
IDEA类注释模板和方法注释模板前言一、设置IDEA 中的类注释模板二、定义方法注释模板每天一个小知识 前言在我们的开发过程中。良好的代码习惯总是重要的（ps：编程两大痛苦：别人不写注释文档，自己写注释文档），而注释模板往往能帮我们省很多事。今给大家分享一下自己常用的模板和设置方法一、设置IDEA 中的类注释模板File -> Settings -> Editor -> Fil
转载
2023-10-10 11:43:47
1354阅读
在网上看了很多都太乱，而且说的不清楚，操作后没有效果，这里我整理一个详细的傻瓜式的操作一、IDEA中设置注释模板主要分为两个部分，分别是类的注释和方法的注释。1、选择File→Settings→Editor→File and Code Templates→Files→Class。可以看到创建Class时引入了一个参数"File Header.java"。对应的是Files旁边的Includes→F
转载
2023-09-06 20:22:05
493阅读
一、在Java类的开头自动注释作者名字和日期等信息这样以后只要我们创建一个类，就会自动显示作者名和日期时间等信息，便于记录！第一步：打开模板（FIle and Code Templates）。（位置如下：File--->Settings--->Editor--->Code Style--->File and Code Templates）。 第二步，选择File
转载
2023-07-20 21:05:08
194阅读
