IDEA 文檔插件 DocView 版本更新:支持編輯文檔註釋

前言

IDEA 文檔插件 Doc View 又更新了新版本,本次更新版本以下:java

  1. 支持在方法右鍵菜單選擇 Doc Editor 直接編輯文檔git

    1. 編輯接口文檔名稱
    2. 編輯接口描述
    3. 編輯字段是否必填
    4. 編輯字段註釋說明
    5. 點擊肯定, 會回寫到源文件的註釋中
  2. 支持在 Entity 中經過郵件菜單選擇Doc Editor 編輯字段信息github

    1. 編輯字段是否必填
    2. 編輯字段註釋說明
    3. 點擊肯定, 會回寫到源文件的註釋中
    4. 支持將 Entity 複製爲 Json 字符串
    5. 複製 Json 字符串時, 支持 Entity 中包含對象的轉換
  3. 從 Doc View 預覽界面直接跳轉到編輯界面

是否是看着挺多的,下面,我們就瞭解下具體都是什麼吧!ui

Doc Editor

在方法右鍵菜單

彈起操做面板,可編輯參數以下:spa

  1. 接口名稱:默認取方法名,當有註釋且註釋 tag 爲 @docName 時,會取 @docName 對應的名稱;
  2. 接口描述:取註釋的描述內容;
  3. 請求/返回參數:請求返回參數的是否必填、描述。

下面使用動圖演示:插件

在實體類右鍵菜單

在實體類中右鍵菜單,其實至關於方法中的請求/返回參數那一部分。code

操做面板操做以下:對象

  1. 是否必填:將使用註釋 tag @required 做爲是否必填的標識。固然也支持 javax.validation.constraints 的部分註解;
  2. 描述信息:描述內容爲註釋內容,修改後會回寫到註釋中;
  3. 複製爲 Json 字符串,支持多級嵌套。

若是上述內容點擊 Copy as Json 會將實體轉換爲 Json 字符串複製到剪貼板。接口

直接從預覽界面跳轉

當打開 Doc View 文檔界面時,左下角能夠經過編輯按鈕跳轉到 Doc Editor 界面。rem

總結

Doc View 本次更新介紹就到這裏就結束了,有興趣的小夥伴,能夠本身安裝體驗。

歡迎小夥伴們提出 Issue 和 PR。

項目地址:https://github.com/liuzhihang...
插件地址:https://plugins.jetbrains.com...

【廣告】

爲了方便溝通交流,我建立了一個技術交流羣,在羣裏能夠交流技術,聊天提問,有興趣的小夥伴能夠經過公衆號加我好友,發送進羣,我會拉你進羣。PS:事先說好哦,不許發廣告。

相關文章
相關標籤/搜索