C#封装程序集属性方法注释说明
程序员文章站
2022-04-12 11:15:53
在很多分布式应用程序开发中,针对每一种功能可能条用的接口不一样,往往习惯将需要被调用的接口,封装成DLL给调用方应用后使用,这样既规范了调用的方式,又避免了调用出现参数请求方式的异常 ......
一.使用封装程序集好处:
在很多分布式应用程序开发中,针对每一种功能可能条用的接口不一样,往往习惯将需要被调用的接口,封装成DLL给调用方应用后使用,这样既规范了调用的方式,又避免了调用出现参数请求方式的异常。
二.自定义封装程序集:
把需要的参数封装成类,添加好注释,调用的方式封装成类,添加好注释,然后在选择项目>属性>输出>勾选XML文档文件:
最后生成的程序集像我们使用.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文档文件,是不会存在提示的。