Java基础——注释

❓注释是干嘛的，有什么意义
💊注释起到对代码进行解释说明的作用，可提高代码的可读性

❓为什么要养成写注释的习惯？
💊方便自己：你今天写的代码一段时间之后你回头看有可能你自己都不知道这写的是什么玩意，但写了注释的话，可以通过注释快速了解业务逻辑。
💊守护家人：如果你没有写注释的习惯，你跳槽之后，接手你工作的同事会使用一长串优美的中国话问候你的家人，没注释人家没法知道你代码的业务逻辑。
💊企业要求：无论大公司还是小公司，都会规定员工写注释，如果你坚持不写注释，一条路走到黑的话，你很难被企业录取，就算被录取你也待不久。

🚀1、单行注释

⭐️语法：// 注释内容
⭐️只能注释一行内容，用在注释信息内容少的地方

// 吃意大利面就得加42号混泥土

🚀2、多行注释

⭐️语法：/* 注释内容 */
⭐️ 能注释多行的内容，一般首行和尾行不写注释信息，这样比较美观

/*
* 翻译翻译什么叫他妈的惊喜
* 这他妈八岁？
* 不好，我成替身了
* */

🚀3、文档注释

⭐️语法：/** */
⭐️文档注释是Java特有的，蝎子拉屎----毒一份，可注释多行内容，配合标签使用

/**
 * @author 阿斌
 * @version 1.0
 * @deprecated 
 */
public class 注释 {
    public static void main(String[] args) {
        System.out.println("学习Java注释！！！");
    }
}

⭐️文档注释常用标签如下：

⭐️文档注释可以通过JDK提供的工具javadoc来解析，生成一套以网页文件形式体现的程序说明文档，命令格式如下：

javadoc -d 存储所生成注释文档的路径 -标签 -标签 xxx.java

⭐️实例：

javadoc -d E:\demo -encoding UTF-8 -author -version -charset UTF-8 HelloWorld.java

⭐️要输出什么标签信息就在命令里加什么标签，我这里设置输出-author(作者)、-version(版本号)

🚀4、有趣的注释

/***
 * ░░░░░░░░░░░░░░░░░░░░░░░░▄░░
 * ░░░░░░░░░▐█░░░░░░░░░░░▄▀▒▌░
 * ░░░░░░░░▐▀▒█░░░░░░░░▄▀▒▒▒▐
 * ░░░░░░░▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐
 * ░░░░░▄▄▀▒░▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐
 * ░░░▄▀▒▒▒░░░▒▒▒░░░▒▒▒▀██▀▒▌
 * ░░▐▒▒▒▄▄▒▒▒▒░░░▒▒▒▒▒▒▒▀▄▒▒
 * ░░▌░░▌█▀▒▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐
 * ░▐░░░▒▒▒▒▒▒▒▒▌██▀▒▒░░░▒▒▒▀▄
 * ░▌░▒▄██▄▒▒▒▒▒▒▒▒▒░░░░░░▒▒▒▒
 * ▀▒▀▐▄█▄█▌▄░▀▒▒░░░░░░░░░░▒▒▒
 * 单身狗就这样默默地看着你，一句话也不说。
 */

👉更多好玩注释

🚀5、插件分享

5.1、Translation

⭐️TranslationPlugin 是一个基于 IntelliJ IDE/Android Studio 的翻译插件。它集成了谷歌翻译、微软翻译、DeepL 翻译、有道翻译、百度翻译等众多翻译引擎，在你的 IDE 内随时对想要翻译的文本、代码注释、代码文档等进行翻译。

👉官方使用文档

5.2、Alibaba Java Coding Guidelines

⭐️为了让开发更加方便、更为规范，阿里巴巴基于手册内容，研发了一套自动化的代码规范检测插件Alibaba Java Coding Guidelines 。该插件在扫描代码后，将不符合规约的代码按Blocker/Critical/Major三个等级显示在下方，甚至在IDEA上，我们还基于Inspection机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。