大佬們如果經常遇到要寫注釋,但是手寫又那么費時間,並且存在有格式標准化的情況下,可以試試使用注釋模板進行配置。教程如下:
1、找到對應的VS所安裝的路徑下。例如我的VS2022版本安裝路徑,如下所示,然后找到對應的版本文件夾,例如我的是企業版,對應的是 Enterprise,最后面幾個路徑基本各個版本都一致,在Common7/IED/ItemTemplates文件夾下。
2、里面是各個代碼的模板配置,可以對代碼模板進行一些修改,這樣咱們在自動生成代碼的時候,就可以額外帶有我們配置的其他功能了,例如代碼文件頭部的版權注釋、或者標准注釋等,或者其他玩法。以下先測試添加一個類文件的效果,在CSharp語言下的Code文件夾下,2052文件夾代表是中文版,1033是英文版,大佬們可以自行選擇對應版本。選擇里面的Class.cs文件打開,進行修改。
3、我此處使用VS CODE打開進行修改,大佬們還可以選擇notepad++或者任意可以編輯的工具,都可以,不局限一樣。我對原有的文件,加了兩處注釋,如圖所示。
4、添加完畢,保存以后,我在此處新建一個項目,然后新建一個類,叫 TestTitleComment,用來驗證添加頭部注釋以后的效果。
5、如下圖所示,在模板配置的信息,自動解析到咱們新建的類文件里面去了。
6、以上只是修改了代碼模板的新建類文件,如果需要修改其他模板,需要在其他模板里面進行進一步修改。以下再舉個Winform窗體的例子。在Windows Form文件夾下,找到form文件夾下的form文件,進行修改。
7、打開form文件,並添加同上面class文件的頭部注釋有關信息,並保存。
8、測試效果,此處新建一個winform項目,新建以后為了測試效果,再添加一個驗證結果的窗體,例如叫TestCommentForm,如下圖所示。
調皮的分割線……………………
9、添加窗體以后,打開對應窗體的代碼文件,如下圖所示,和配置文件信息一致。
10、其他代碼文件的配置信息,如上類似,各位大佬可以自行研究,祝大佬們好運。