2020版IDEA項目註釋規範設置

前言

編碼規範,代表了我們的編碼風格,在企業裏面是很重要的,比如註釋規範,現在我們來看看最新版(阿里巴巴編碼手冊-泰山版)

  1. 【強制】類、類屬性、類方法的註釋必須使用 Javadoc 規範,使用/*內容/格式,不得使用
    // xxx 方式。

一、類註釋

/**
 * @description: TODO
 * @author: ydf
 * @date: ${DATE} ${TIME}
 * @version: v1.0
 */

可根據實際需求更改,修改成功之後可能不生效,重啓idea即可
在這裏插入圖片描述
測試如下:
在這裏插入圖片描述

二、方法註釋

2.1 新建template group:
在這裏插入圖片描述
2.2 自定義命名:
在這裏插入圖片描述
2.3 創建template:
在這裏插入圖片描述
2.4 設置template格式:
在這裏插入圖片描述
2.5 設置模板參數:
在這裏插入圖片描述
在這裏插入圖片描述
2.6 設置模板的應用場景
在這裏插入圖片描述
點擊模板頁面最下方的警告,來設置將模板應用於那些場景,一般選擇EveryWhere–>Java即可
在這裏插入圖片描述
使用測試:創建方法,在方法上面寫:// 回車即可
在這裏插入圖片描述

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章