IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> JAVA程序员日常编码遵守注释规范 -> 正文阅读

[开发工具]JAVA程序员日常编码遵守注释规范

作者:https://img-blog.csdnimg.cn/24144ce4432f470eb9a6f8c277cad55a.png


? ? ? ? ?早在2017年9月25日阿里巴巴发布了第一版的Java开发手册,到现在也已经有4个版本了,分别是2017(终极版),2018(详尽版),2019(华山版)和2020(泰山本)。其中有条就是注释规约。这样不仅避免代码整理时容易发生的争执。而且在统一的注释规范,大家互相看着也方便。更重要的是也会养成一个良好的习惯。

首先推荐一款idea插件:

一、 Alibaba Java Coding Guidelines插件

介绍:这款插件可以在日常写代码中检测不合适的代码自动提示帮助我们及时更正养成良好的编码习惯。

下载步骤:

打开File----->Setting----->Plugins界面,搜索Alibaba,如下图
在这里插入图片描述点击installed安装。我这里已经安装过了,所以是灰色按钮,正常第一次安装之后他会提示重启idea生效。

二、类注释

? ? ? ?在你下载完插件之后,他会对你的代码进行扫描,不合规范的会用黄色波浪线提示。而接下来我们每次创建一个类的时候,如果没有类注释的话你的类名就会有黄色波浪线提示。

如图,比如创建一个User类:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TVVVA0TM-1652172499096)(C:\Users\EDZ\AppData\Roaming\Typora\typora-user-images\1652169091656.png)]
它会提示User类缺少作者的注释信息。遇到这种情况,我们可以创建一个类注释模板。

创建类注释模板:

(1).打开File----->Setting----->Editor----->File and Code Templates界面,点击Class,如图:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-FOqX5cHX-1652172499097)(C:\Users\EDZ\AppData\Roaming\Typora\typora-user-images\1652169409413.png)]
(2).复制以下代码到模板中

/** 
* @Description: TODO
* @author: baiyixiao
* @date: ${YEAR}-${MONTH}-${DAY} ${TIME}
*/

@author选项,写个人作者署名,入下图:
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-MMV0sZG8-1652172499098)(C:\Users\EDZ\AppData\Roaming\Typora\typora-user-images\1652169628965.png)]
点击Apply,然后点击OK。这样我们接下来每次创建类他就会自动跟类创建好。
在这里插入图片描述
也没有再有黄色波浪线了。

三、方法注释

? ? ? ?和类一样,每个方法上都要求有Javadoc注释,注释内容要求返回值有类型,参数,方法描述说明。

创建方法注释模板:

(1).打开File----->Setting----->Editor----->Live Templates界面,点击右侧的+号按钮,选择Template Group选项。
在这里插入图片描述
(2).在弹出的界面中新建一个为MyGroup的选项,点击OK。
在这里插入图片描述
(3).再次点击右边+号按钮,选择Live Template选项。
在这里插入图片描述
(4).将下面这段注释复制:

**
 * description: 
 * 
$param$ 
 * @return $return$
 */

(5).

  • 设置快捷键
  • 复制内容到Template text里
  • 切换Expend with为Tab
  • 点击Edit varibles
    在这里插入图片描述
    (6).复制param要填入的表达式:
groovyScript(
        "def result=''; 
        def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); 
        for(i = 0; i < params.size(); i++) {
            result +=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; 
            return result ", methodParameters())

? ?(7).

  • 1.将上面param表达式复制到Exprrssion里
  • 2.return的Exprrssion选择methodReturnType()选项
  • 3.Skip if defined里面都勾选对号。
  • 4.点击OK。
    在这里插入图片描述
    (8).再次点击OK。
    在这里插入图片描述
    (9).在方法上输入/*+Tab键:
    在这里插入图片描述
    这样就完成了。

? ? ? ? ?这样在每次编码时候,都去给类,方法,接口都做一个注释,是真的会养成一个很好的编程习惯。

  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章           查看所有文章
加:2022-05-12 16:36:29  更:2022-05-12 16:37:14 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年11日历 -2024/11/26 1:39:22-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码