注释规范

• 类模块注释（可以通过自定义来完成）

/*
 * 创建人：XXX
 * 创建时间：2019-9-13
 * 说明：本类是用于XXX
 * 版权说明：XXX公司
 */

此链接是自定义模块注释

• 函数的注释

        #region 取出当前所有新闻分类
        /// <summary>
        /// 取出当前所有新闻分类
        /// </summary>
        /// <returns>DataTable</returns>
        public DataTable SelectAll()
        {
            DataTable dt = new DataTable();
            string sql = "select * from category";
            dt = sqlhelper.ExecuteQuery(sql, CommandType.Text);
            return dt;
        }
        #endregion

让我们看一下效果：

• 注释todo，相当与书签，可以很快找到刚才还未修改完成的代码（再方法体内写）

public DataTable SelectByCaId(string caid)
        {
            //TODO:根据类别ID取出该类别下的所有新闻
            DataTable dt = new DataTable();
            string procName = "news_selectByCaId";
            SqlParameter[] paras = new SqlParameter[]
            {
                new SqlParameter("@caid",caid)
            };
            dt = sqlhelper.ExecuteQuery(procName, paras, CommandType.StoredProcedure);
            return dt;
        }

如何查看：

视图>>任务列表（Ctrl+W，T）