1. 程式人生 > 其它 >【不費腦筋系列】為程式添加註釋模板/版權註釋/自定義頭部註釋等

【不費腦筋系列】為程式添加註釋模板/版權註釋/自定義頭部註釋等

大佬們如果經常遇到要寫註釋,但是手寫又那麼費時間,並且存在有格式標準化的情況下,可以試試使用註釋模板進行配置。教程如下:

1、找到對應的VS所安裝的路徑下。例如我的VS2022版本安裝路徑,如下所示,然後找到對應的版本資料夾,例如我的是企業版,對應的是Enterprise,最後面幾個路徑基本各個版本都一致,在Common7/IED/ItemTemplates資料夾下。

2、裡面是各個程式碼的模板配置,可以對程式碼模板進行一些修改,這樣咱們在自動生成程式碼的時候,就可以額外帶有我們配置的其他功能了,例如程式碼檔案頭部的版權註釋、或者標準註釋等,或者其他玩法。以下先測試新增一個類檔案的效果,在

CSharp語言下的Code資料夾下,2052資料夾代表是中文版,1033是英文版,大佬們可以自行選擇對應版本。選擇裡面的Class.cs檔案開啟,進行修改。

3、我此處使用VSCODE開啟進行修改,大佬們還可以選擇notepad++或者任意可以編輯的工具,都可以,不侷限一樣。我對原有的檔案,加了兩處註釋,如圖所示。

4、新增完畢,儲存以後,我在此處新建一個專案,然後新建一個類,叫TestTitleComment,用來驗證新增頭部註釋以後的效果。

5、如下圖所示,在模板配置的資訊,自動解析到咱們新建的類檔案裡面去了。

6、以上只是修改了程式碼模板的新建類檔案,如果需要修改其他模板,需要在其他模板裡面進行進一步修改。以下再舉個

Winform窗體的例子。在WindowsForm資料夾下,找到form資料夾下的form檔案,進行修改。

7、開啟form檔案,並新增同上面class檔案的頭部註釋有關資訊,並儲存。

8、測試效果,此處新建一個winform專案,新建以後為了測試效果,再新增一個驗證結果的窗體,例如叫TestCommentForm,如下圖所示。

調皮的分割線……………………

9、新增窗體以後,開啟對應窗體的程式碼檔案,如下圖所示,和配置檔案資訊一致。

10、其他程式碼檔案的配置資訊,如上類似,各位大佬可以自行研究,祝大佬們好運。

歡迎加入QQ群: 群號:1079830632