推薦兩個自動生成注釋的 開源輕量級 Visual Studio 插件


工欲善其事必先利其器,而 Visual Studio 就是我們的開發利器。

上一篇文章,介紹了一個很簡單的方式去 制作代碼片段(Code Snippet),對於編寫代碼本身,也是可以進行封裝與重用的。

這篇文章,推薦兩個自動生成注釋的 開源輕量級 Visual Studio 插件。

1. 前言

在開發的過程中,寫注釋也是一個很好的習慣,這些注釋不僅僅對其他開發者有幫助,對自己也是有幫助的。

因為在若干月之后,可能就不知道當初的某一個方法,屬性到底在做什么,有什么需要注意的地方。

很多公司也會基於這些注釋 來生成代碼文檔用於查閱與交付。也如Swagger框架 在生成測試接口時,也可以將注釋一並展示。

2. 介紹

以下插件都是通過 快速操作(Quick Action) 來完成,快捷鍵為 (Alt+Enter or Ctrl+.)。

他們的本質為拓展 VS 的 代碼分析器(code analyzer) 和 代碼修補(code fix)。

1. Pull Through Documentation

此插件適用於 有父類或者接口的情況,可以從父類的相同成員中,抽取其注釋到子類的相同成員中。

舉例:

有一個接口為

interface IMyInterface 
{
    /// <summary>
    /// This method does something
    /// </summary>
    void DoSomething();
}

有一個子類為

class MyClass : IMyInterface
{
    public void DoSomething();
}

通過代碼抽取:

下載地址:Pull Through Documentation - Visual Studio Marketplace

github地址:PullThroughDoc - github

支持的 VS版本: 2017,2019

 

2. DocumentationAssistant (自己寫的,歡迎關注哦!)

此插件適用於任何情況,能夠根據成員的結構信息來生成注釋。

實操展示- 借助於鼠標

實操展示- 借助於快捷鍵(Alt+Enter or Ctrl+.)

下載地址:DocumentationAssistant - Visual Studio Marketplace

github地址:DocumentationAssistant - github 

支持的 VS版本: 2017,2019

3. 總結

這兩個插件可以極大的縮短寫注釋所需要的時間,使開發者更聚焦於代碼本身。

對於大部分簡單的成員(類,字段,屬性,方法等),如果命名良好的話可以直接生成,而對於需要詳細解釋的,可以基於生成的注釋來補充,效率會更高。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM