兄弟 Goland 咱能一次性將注釋設(shè)置好不
大家好，我是阿兵云原生
工作中我們都只是寫注釋是一個好習(xí)慣，作為新生代的農(nóng)名工，特別煩的就是別人不寫注釋，但是自己偏偏又不喜歡寫注釋??????
對于 golang 的注釋，我發(fā)現(xiàn)很多新朋友總是自己去寫注釋，這沒毛病
但是咱們沒必要所有注釋都自己寫，這耗時耗力，明明有工具可以提高我們的效率，咱們就不要用手寫了，咱們來看看 goland 如何給我們自動生成各種注釋，分別為如下兩個方面
直接 使用插件 Goanno 的方式來進行注釋
簡單說明一下 Goland 的文件注釋 和 Goland 的函數(shù)注釋
直接 使用插件 Goanno 的方式來對方法、接口、結(jié)構(gòu)體注釋模板配置
1、簡單安裝 Goanno 插件
File->Settings->Plugins ,
搜索 Goanno
配置 Goanno 插件，按照如下方式配置后，點擊 submit 即可生效
Normal Method 配置內(nèi)容如下：
//?@Title?${function_name}?
//?@Description?${todo}?
//?@Author?zhangxinmin?${date}?${time}?
//?@Param?${params}?
//?@Return?${return_types}?
Interface 配置內(nèi)容如下：
//?${interface_name}?
Interface Method 配置內(nèi)容如下：
//?@Title?${function_name}?
//?@Description?${todo}?
//?@Author?zhangxinmin?${date}?${time}?
//?@Param?${params}?
//?@Return?${return_types}?
Struct配置內(nèi)容如下：
//?${struct_name}
開始在我們的代碼中驗證注釋， 在方法、結(jié)構(gòu)體、接口上 使用 快捷鍵 ctrl +alt +/ （windows 系統(tǒng)）， 如果是 mac 可以使用 control + commond + / 快捷鍵,
具體效果可以見下圖
Goland 文件注釋
goland 菜單路徑：
File->Settings->Editor->File and Code Templates 打開如下對話框
并在 Go File 對應(yīng)的框中寫入如下信息：
//?@Author?Bing?
//?@Date?${DATE}?${TIME}:00?
//?@Desc
package?${GO_PACKAGE_NAME}?
驗證新建文件的效果
Goland 函數(shù)注釋
goland 菜單路徑
File->Settings->Editor->Live Templates 打開如下對話框
點擊 ”+”選擇Live Template
寫入代碼模板名 hhh，這也是之后的快捷鍵
新建方法修改注釋模板，配置內(nèi)容如下
填寫如下內(nèi)容
//?@author?By?Bing?$date$?$time$:00?
//?@Reason?
//?@Demand?Version
點擊 Edit variables 編輯變量
咱們填入具體的 date() 和 time()
點擊 define 應(yīng)用到 GO 上面
在 golang 代碼中，敲入 hhh 就可以看到注釋
當(dāng)然我們也可以設(shè)置復(fù)雜一些，能夠滿足我們的自定義需求即可
新手通過如上的方式設(shè)置之后，不僅咱們寫注釋的效率提高了，我們寫注釋的模板也可以統(tǒng)一了，不會出現(xiàn)同一個人，一會是這種風(fēng)格的注釋，一會又是另外一種方格的注釋了
本文結(jié)束，感謝閱讀，歡迎交流，點個贊，關(guān)注一波 再走吧
歡迎點贊，關(guān)注，收藏
朋友們，你的支持和鼓勵，是我堅持分享，提高質(zhì)量的動力
好了，本次就到這里
技術(shù)是開放的，我們的心態(tài)，更應(yīng)是開放的。擁抱變化，向陽而生，努力向前行。
我是阿兵云原生，歡迎點贊關(guān)注收藏，下次見~
