优化注释

2023-02-17 11:00:26 +08:00 · 2023-02-17 11:00:26 +08:00 · a51c85fcad
commit a51c85fcad
parent 5e2fc60ba5
5 changed files with 158 additions and 99 deletions
--- a/Infrastructure/Constant/HttpStatus.cs
+++ b/Infrastructure/Constant/HttpStatus.cs
@ -40,9 +40,9 @@ namespace Infrastructure.Constant
        /// </summary>
        public static readonly int NOT_MODIFIED = 304;

-        /**
-         * 参数列表错误（缺少，格式不匹配）
-         */
+        /// <summary>
+        /// 参数列表错误（缺少，格式不匹配）
+        /// </summary>
        public static readonly int BAD_REQUEST = 400;

        /// <summary>
@ -50,39 +50,39 @@ namespace Infrastructure.Constant
        /// </summary>
        public static readonly int UNAUTHORIZED = 401;

-        /**
-         * 访问受限，授权过期
-         */
+        /// <summary>
+        /// 访问受限，授权过期
+        /// </summary>
        public static readonly int FORBIDDEN = 403;

-        /**
-         * 资源，服务未找到
-         */
+        /// <summary>
+        /// 资源，服务未找到
+        /// </summary>
        public static readonly int NOT_FOUND = 404;

-        /**
-         * 不允许的http方法
-         */
+        /// <summary>
+        /// 不允许的http方法
+        /// </summary>
        public static readonly int BAD_METHOD = 405;

-        /**
-         * 资源冲突，或者资源被锁
-         */
+        /// <summary>
+        /// 资源冲突，或者资源被锁
+        /// </summary>
        public static readonly int CONFLICT = 409;

-        /**
-         * 不支持的数据，媒体类型
-         */
+        /// <summary>
+        /// 不支持的数据，媒体类型
+        /// </summary>
        public static readonly int UNSUPPORTED_TYPE = 415;

-        /**
-         * 系统内部错误
-         */
+        /// <summary>
+        /// 系统内部错误
+        /// </summary>
        public static readonly int ERROR = 500;

-        /**
-         * 接口未实现
-         */
+        /// <summary>
+        /// 接口未实现
+        /// </summary>
        public static readonly int NOT_IMPLEMENTED = 501;
    }
 }
--- a/Infrastructure/Enums/BusinessType.cs
+++ b/Infrastructure/Enums/BusinessType.cs
@ -1,64 +1,58 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
-namespace Infrastructure.Enums
+namespace Infrastructure.Enums
 {
-    /**
-     * 业务操作类型
-     * 0=其它,1=新增,2=修改,3=删除,4=授权,5=导出,6=导入,7=强退,8=生成代码,9=清空数据
-     * @author zrry
-     */
+    /// <summary>
+    /// 业务操作类型 0=其它,1=新增,2=修改,3=删除,4=授权,5=导出,6=导入,7=强退,8=生成代码,9=清空数据
+    /// </summary>
    public enum BusinessType
    {
-        /**
-     * 其它
-     */
+        /// <summary>
+        /// 其它
+        /// </summary>
        OTHER = 0,

-        /**
-         * 新增
-         */
+        /// <summary>
+        /// 新增
+        /// </summary>
        INSERT = 1,

-        /**
-         * 修改
-         */
+        /// <summary>
+        /// 修改
+        /// </summary>
        UPDATE = 2,

-        /**
-         * 删除
-         */
+        /// <summary>
+        /// 删除
+        /// </summary>
        DELETE = 3,

-        /**
-         * 授权
-         */
+        /// <summary>
+        /// 授权
+        /// </summary>
        GRANT = 4,

-        /**
-         * 导出
-         */
+        /// <summary>
+        /// 导出
+        /// </summary>
        EXPORT = 5,

-        /**
-         * 导入
-         */
+        /// <summary>
+        /// 导入
+        /// </summary>
        IMPORT = 6,

-        /**
-         * 强退
-         */
+        /// <summary>
+        /// 强退
+        /// </summary>
        FORCE = 7,

-        /**
-         * 生成代码
-         */
+        /// <summary>
+        /// 生成代码
+        /// </summary>
        GENCODE = 8,

-        /**
-         * 清空数据
-         */
+        /// <summary>
+        /// 清空数据
+        /// </summary>
        CLEAN = 9,
    }
 }
--- a/ZR.CodeGenerator/GenConstants.cs
+++ b/ZR.CodeGenerator/GenConstants.cs
@ -31,28 +31,44 @@ namespace ZR.CodeGenerator
        public static readonly string[] radioFiled = new string[] { "status", "state", "is"};


-        /** 单表（增删改查） */
+        /// <summary>
+        /// 单表（增删改查）
+        /// </summary>
        public static string TPL_CRUD = "crud";

-        /** 树表（增删改查） */
+        /// <summary>
+        /// 树表（增删改查）
+        /// </summary>
        public static string TPL_TREE = "tree";

-        /** 主子表（增删改查） */
+        /// <summary>
+        /// 主子表（增删改查）
+        /// </summary>
        public static string TPL_SUB = "sub";

-        /** 树编码字段 */
+        /// <summary>
+        /// 树编码字段
+        /// </summary>
        public static string TREE_CODE = "treeCode";

-        /** 树父编码字段 */
+        /// <summary>
+        /// 树父编码字段
+        /// </summary>
        public static string TREE_PARENT_CODE = "treeParentCode";

-        /** 树名称字段 */
+        /// <summary>
+        /// 树名称字段
+        /// </summary>
        public static string TREE_NAME = "treeName";

-        /** 上级菜单ID字段 */
+        /// <summary>
+        /// 上级菜单ID字段
+        /// </summary>
        public static string PARENT_MENU_ID = "parentMenuId";

-        /** 上级菜单名称字段 */
+        /// <summary>
+        /// 上级菜单名称字段
+        /// </summary>
        public static string PARENT_MENU_NAME = "parentMenuName";

        /** 数据库字符串类型 */
--- a/ZR.Model/System/SysOperLog.cs
+++ b/ZR.Model/System/SysOperLog.cs
@ -11,25 +11,34 @@ namespace ZR.Model.System
    {
        [SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
        public long OperId { get; set; }
-        /** 操作模块 */
+        /// <summary>
+        /// 操作模块
+        /// </summary>
        [DisplayName("操作模块")]
        public string Title { get; set; }

-        /** 业务类型（0其它 1新增 2修改 3删除） */
-        //@Excel(name = "业务类型", readConverterExp = "0=其它,1=新增,2=修改,3=删除,4=授权,5=导出,6=导入,7=强退,8=生成代码,9=清空数据")
+        /// <summary>
+        /// 业务类型（0其它 1新增 2修改 3删除 4=授权,5=导出,6=导入,7=强退,8=生成代码,9=清空数据）
+        /// </summary>
        [DisplayName("业务类型")]
        public int BusinessType { get; set; }

-        /** 业务类型数组 */
+        /// <summary>
+        /// 业务类型数组
+        /// </summary>
        [SugarColumn(IsIgnore = true)]
        [ExcelIgnore]
        public int[] BusinessTypes { get; set; }

-        /** 请求方法 */
+        /// <summary>
+        /// 请求方法
+        /// </summary>
        [DisplayName("请求方法")]
        public string Method { get; set; }

-        /** 请求方式 */
+        /// <summary>
+        /// 请求方式
+        /// </summary>
        [DisplayName("请求方式")]
        public string RequestMethod { get; set; }

--- a/ZR.Model/System/UserConstants.cs
+++ b/ZR.Model/System/UserConstants.cs
@ -6,59 +6,99 @@ namespace ZR.Model.System
 {
    public class UserConstants
    {
-        /**
-    * 平台内系统用户的唯一标志
-    */
+        /// <summary>
+        /// 平台内系统用户的唯一标志
+        /// </summary>
        public static string SYS_USER = "SYS_USER";

-        /** 正常状态 */
+        /// <summary>
+        /// 正常状态
+        /// </summary>
        public static string NORMAL = "0";

-        /** 异常状态 */
+        /// <summary>
+        /// 异常状态
+        /// </summary>
        public static string EXCEPTION = "1";

-        /** 用户封禁状态 */
+        /// <summary>
+        /// 用户封禁状态
+        /// </summary>
        public static string USER_DISABLE = "1";

-        /** 角色封禁状态 */
+        /// <summary>
+        /// 角色封禁状态
+        /// </summary>
        public static string ROLE_DISABLE = "1";

-        /** 部门正常状态 */
+        /// <summary>
+        /// 部门正常状态
+        /// </summary>
        public static string DEPT_NORMAL = "0";

-        /** 部门停用状态 */
+        /// <summary>
+        /// 部门停用状态
+        /// </summary>
        public static string DEPT_DISABLE = "1";

-        /** 字典正常状态 */
+        /// <summary>
+        /// 字典正常状态
+        /// </summary>
        public static string DICT_NORMAL = "0";

-        /** 是否为系统默认（是） */
+        /// <summary>
+        /// 是否为系统默认（是）
+        /// </summary>
        public static string YES = "Y";

-        /** 是否菜单外链（是） */
+        /// <summary>
+        /// 是否菜单外链（是）
+        /// </summary>
        public static string YES_FRAME = "1";

-        /** 是否菜单外链（否） */
+        /// <summary>
+        /// 是否菜单外链（否）
+        /// </summary>
        public static string NO_FRAME = "0";

-        /** 菜单类型（目录） */
+        /// <summary>
+        /// 菜单类型（目录）
+        /// </summary>
        public static string TYPE_DIR = "M";

-        /** 菜单类型（菜单） */
+        /// <summary>
+        /// 菜单类型（菜单）
+        /// </summary>
        public static string TYPE_MENU = "C";

-        /** 菜单类型（按钮） */
+        /// <summary>
+        /// 菜单类型（按钮）
+        /// </summary>
        public static string TYPE_BUTTON = "F";
-        /** 菜单类型（链接） */
+
+        ///// <summary>
+        ///// 菜单类型（链接）
+        ///// </summary>
        //public static string TYPE_LINK = "L";

-        /** Layout组件标识 */
+        /// <summary>
+        /// Layout组件标识
+        /// </summary>
        public static string LAYOUT = "Layout";
-        /** ParentView组件标识 */
+
+        /// <summary>
+        /// ParentView组件标识
+        /// </summary>
        public static string PARENT_VIEW = "ParentView";
-        /** InnerLink组件标识 */
+
+        /// <summary>
+        /// InnerLink组件标识
+        /// </summary>
        public static string INNER_LINK = "InnerLink";
-        /** 校验返回结果码 */
+
+        /// <summary>
+        /// 校验返回结果码
+        /// </summary>
        public static string UNIQUE = "0";
        public static string NOT_UNIQUE = "1";