天天看點

C#封裝程式集屬性方法注釋說明

一.使用封裝程式集好處:

在很多分布式應用程式開發中,針對每一種功能可能條用的接口不一樣,往往習慣将需要被調用的接口,封裝成DLL給調用方應用後使用,這樣既規範了調用的方式,又避免了調用出現參數請求方式的異常。

二.自定義封裝程式集:

把需要的參數封裝成類,添加好注釋,調用的方式封裝成類,添加好注釋,然後在選擇項目>屬性>輸出>勾選XML文檔檔案:

C#封裝程式集屬性方法注釋說明

最後生成的程式集像我們使用.NET Framework的類的時候一樣?有智能提示。

舉例:我有以下實體:

1     /// <summary>
 2     /// 郵件内容實體
 3     /// </summary>
 4     public class EmailEntity
 5     {
 6         /// <summary>
 7         /// 郵件類型-模闆類型
 8         /// </summary>
 9         public int EType { get; set; }
10         /// <summary>
11         /// 郵件位址
12         /// </summary>
13         public string Email { get; set; }
14         /// <summary>
15         /// 郵件參數-
16         /// 參數對象為Json字元串
17         /// </summary>
18         public string EParameter { get; set; }
19         /// <summary>
20         /// 添加郵件Web位址
21         /// </summary>
22         public string EmailPushUrl { get; set; }
23     }      

選擇項目>屬性>輸出>勾選XML文檔檔案:生成以後:類似我們使用.NET Framework的類的時候一樣,有智能提示。如果不勾選輸出為XML文檔檔案,是不會存在提示的。

C#封裝程式集屬性方法注釋說明

部落格内容僅代表個人觀點,如發現闡述有誤,麻煩指正,謝謝!