WingCloudServer/Tools/GeneralDocTool/Model/MemberEntity.cs

using System.Collections.Generic;

namespace WingCloudServer.GeneralDocTools.Model
{
    /// <summary>
    /// 注释实体
    /// </summary>
    public class MemberEntity
    {
        /// <summary>
        /// 参数名
        /// </summary>
        public string ParamName { get; set; } = string.Empty;

        /// <summary>
        /// 注释
        /// </summary>
        public string Summary { get; set; } = string.Empty;

        /// <summary>
        /// 方法注释用：返回内容的默认值，当返回简单类型时【bool，int，string等等】，默认值必填，如果非简单类型，则非不填；
        /// </summary>
        public string Value { get; set; } = string.Empty;

        /// <summary>
        /// 参数对象实体
        /// </summary>
        public List<ParamEntity> Param { get; set; } = new List<ParamEntity>();

        /// <summary>
        /// 返回描述
        /// </summary>
        public string Returns { get; set; } = string.Empty;

        /// <summary>
        /// 代码 | 错误描述  ：这个内容必须按照此格式进行记录，用于生成文档时，枚举表格的抬头；
        /// </summary>
        public string Remarks { get; set; } = string.Empty;

        /// <summary>
        /// 类注释：显示为该属性是否是必填项，当前1-表示必填，0-表示非必填，默认必填
        /// </summary>
        public string Code { get; set; } = "1";

        /// <summary>
        /// 类注释：此项为非必填项，当这个方法与接口上声明的调用端不一致时，用来指定特殊的一级目录；
        /// </summary>
        public string DocFirstDirectory { get; set; } = "";

        /// <summary>
        /// 类注释：此项为非必填项，当这个方法与接口上声明的二级目录不一致时，用来指定特殊的二级目录；
        /// </summary>
        public string DocSecondDirectory { get; set; } = "";

        /// <summary>
        /// 类注释：此项为非必填项，当这个方法与接口上声明的三级目录不一致时，用来指定特殊的三级目录；
        /// </summary>
        public string DocThirdDirectory { get; set; } = "";

        /// <summary>
        /// 枚举注释： 用来显示枚举信息；
        /// </summary>
        public string EnumDocFirstDirectory { get; set; } = "";

        /// <summary>
        /// 通知注释： 用来显示通知信息；
        /// </summary>
        public string NotificationDocFirstDirectory { get; set; } = "";

        /// <summary>
        /// 通知注释：此项为非必填项，当这个方法与接口上声明的二级目录不一致时，用来指定特殊的二级目录；
        /// </summary>
        public string NotificationDocSecondDirectory { get; set; } = "";

        /// <summary>
        /// 通知注释：此项为非必填项，当这个方法与接口上声明的三级目录不一致时，用来指定特殊的二级目录；
        /// </summary>
        public string NotificationDocThirdDirectory { get; set; } = "";
        /// <summary>
        /// 表示接口中可能会返回的错误码，中间以逗号相隔；非必填
        /// </summary>
        public string ErrorCodes { get; set; } = "";

        /// <summary>
        /// 类注释：false表示此方法不在文档中展示，true表示在文档展示，默认此标签可不加-此时值为true；注：若接口和方法同时出现此标签，以false值为最优先级；
        /// </summary>
        public bool Show { get; set; } = true;
    }

    /// <summary>
    /// 参数实体
    /// </summary>
    public class ParamEntity
    {
        /// <summary>
        /// 参数名称
        /// </summary>
        public string ParamName { get; set; } = string.Empty;

        /// <summary>
        /// 参数值
        /// </summary>
        public string ParamText { get; set; } = string.Empty;
    }

    /// <summary>
    /// 查询遍历不同接口下的方法
    /// </summary>
    public class QueryMethodMemberEntity
    {
        /// <summary>
        /// 一级目录
        /// </summary>
        public string DocFirstDirectory { get; set; } = "";

        /// <summary>
        /// 二级目录
        /// </summary>
        public string DocSecondDirectory { get; set; } = "";

        /// <summary>
        /// 三级目录
        /// </summary>
        public string DocThirdDirectory { get; set; } = "";

        /// <summary>
        /// 通知注释： 一级目录；
        /// </summary>
        public string NotificationDocFirstDirectory { get; set; } = "";

        /// <summary>
        /// 通知注释：二级目录；
        /// </summary>
        public string NotificationDocSecondDirectory { get; set; } = "";

        /// <summary>
        /// 通知注释：三级目录；
        /// </summary>
        public string NotificationDocThirdDirectory { get; set; } = "";

        public int DirectoryType { get; set; } = 2;

        /// <summary>
        /// 方法类
        /// </summary>
        public MemberEntity MethodInfo { get; set; } = new MemberEntity();

        /// <summary>
        /// 接口类型
        /// </summary>
        public Type InterfaceType { get; set; }

        /// <summary>
        /// 接口信息
        /// </summary>
        public InterfaceBasicInfoEntity InterfaceEntity { get; set; } = new InterfaceBasicInfoEntity();
    }

    public class BaseEntity
    {
        /// <summary>
        /// key值
        /// </summary>
        public string Key { get; set; } = "";

        /// <summary>
        /// value值
        /// </summary>
        public string Value { get; set; } = "";
    }
}