**常量、变量注释** --- 必要性：必须，非要重要 > 特别是全局常量必须要注释 **修改其他人代码注释** --- 必要性：必须，非要重要 ``` // 2020-3-12 姜帆 // 为了满足什么业务需求，删除、添加、修改 xxx 功能 // 注释 原来代码 // 2020-3-12 姜帆 // 修改xxx bug // 注释 原来代码 ``` **方法、函数、接口注释** --- 必要性：必须，入参和出参可不写 示例 ~~~ /// <summary> /// 获取全部生产工单列表 /// 包括减震器 和 配件 /// </summary> /// <param name="input"></param> /// <returns></returns> Task<PagedResultDto<MODetailItemDto>> GetMODetails(MODetailPageInput input); ~~~ **实体类、DTO、MODEL注释** --- 必要性：必须 示例 ~~~ /// <summary>    /// 检验表    /// </summary>    public class CheckTable     {        /// <summary>        /// 租户id        /// </summary>        public virtual int? TenantId { get; set; }        /// <summary>        /// 所属组织id        /// </summary>        public virtual long? OrgId { get; set; }        /// <summary>        /// 检验表代码        /// </summary>        public virtual string CheckTableCode { get; set; }        /// <summary>        /// 检验表名称        /// </summary>        public virtual string CheckTableName { get; set; }    } ~~~ **代码块注释** --- 必要性：不是必须，写复杂逻辑，和调用到外部变量的时候需要注释 **区域注释** --- 必要性：不是必须 ~~~ #region 初始化 #endregion  ~~~ **待开发功能** --- ``` // todo 功能描述 ```