文章目錄

• 一、class注釋
• 二、method注釋

一、class注釋

創(chuàng)建class類的時候，生成注釋規(guī)約

【類型1】

/*** @ClassName: ${NAME}* @Description: TODO* @Author: ffideal* @Date: ${DATE} ${TIME}* @Version: v1.0**/

【類型2】

/*** @ClassName : $NAME$* @author : ffideal* @Description : TODO(用一句話描述該類做什么) * @projectname : * @version : 1.0* @DATE : Created in $TIME$ $DATE$* <pre> Copyright: Copyright(c)2019 </pre>* <pre> Company : </pre>* Modification History:* Date Author Version Discription* --------------------------------------------------------------------------* $DATE$ ffideal 1.0 Why & What is modified: <修改原因描述> * */

Step 1

File -> Settings -> File and Code Templates -> Includes -> File Header ->文本框中將上面的注釋添加進去 ->OK

二、method注釋

【類型1】

/*** @Description: $description$方法是* @param: $param$* @return: $return$* @auther: ffideal* @date: $date$ $time$*/

Step 1

Settings -> Live Templates -> Template Groups

Step 2

創(chuàng)建一個新組，并輸入新組的名稱

Step 3

生成完畢后

Live Templates -> 點擊新組，單擊右側(cè)的“+”號 -> 選擇Live Template -> 4 -> 5 -> 填入相關(guān)的context

Step 4

點擊“Edit variable” ->輸入如下

NameExpression

Param	methodParameter()
return	methodReturnType()
description	methodName()
date	date()
time	time()

Step 5

在界面下方Define -> 勾選 Java

Step 6

使用方法：

創(chuàng)建方法，在方法上一行，輸入 / ，然后回車

Step 7

大功告成

總結(jié)

以上是生活随笔為你收集整理的【注释规约】规范化的第一步，你类和方法的注释，规范嘛？的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。