C#封装程序集自定义类方法注释提示

时间:2023-03-09 13:34:11
C#封装程序集自定义类方法注释提示

一.为什么使用封装程序集:

在很多分布式应用程序开发中,针对每一种功能可能条用的接口不一样,往往习惯将需要被调用的接口,封装成DLL给调用方应用后使用,这样既规范了调用的方式,又避免了调用出现参数请求方式的异常。

二.自定义封装程序集:

把需要的参数封装成类,添加好注释,调用的方式封装成类,添加好注释,然后在选择项目>属性>输出>勾选XML文档文件:

C#封装程序集自定义类方法注释提示

最后生成的程序集像我们使用.NET Framework的类的时候一样?有智能提示。

举例:我有以下实体:

    /// <summary>
    /// 邮件内容实体
    /// </summary>
    public class EmailEntity
    {
        /// <summary>
        /// 邮件类型-模板类型
        /// </summary>
        public int EType { get; set; }
        /// <summary>
        /// 邮件地址
        /// </summary>
        public string Email { get; set; }
        /// <summary>
        /// 邮件参数-
        /// 参数对象为Json字符串
        /// </summary>
        public string EParameter { get; set; }
        /// <summary>
        /// 添加邮件Web地址
        /// </summary>
        public string EmailPushUrl { get; set; }
    }

选择项目>属性>输出>勾选XML文档文件:生成以后:类似我们使用.NET Framework的类的时候一样,有智能提示。如果不勾选输出为XML文档文件,是不会存在提示的。

C#封装程序集自定义类方法注释提示