项目开发规范文档-->注释规范

    服务实现类注释规范

  注释:注意返回类型为枚举类型的命名空间格式

    /// <summary>
    /// Member服务实现类
    /// </summary>
    public class MemberService
    {
        /// <summary>
        /// 会员信息
        /// </summary>
        /// <param name="id">会员主键</param>
        /// <returns>会员实体对象</returns>
        public Data.DomainModels.Member QueryDetail(string id) { }

        /// <summary>
        /// 会员信息,列表查询
        /// </summary>
        /// <param name="top">前N条数据</param>
        /// <returns>IList`Data.DomainModels.Member`</returns>
        public IList<Data.DomainModels.Member> QueryList(int top) { }

        /// <summary>
        /// 会员信息,分页查询
        /// </summary>
        /// <param name="page">当前页</param>
        /// <param name="size">页大小</param>
        /// <returns>PageList`Data.DomainModels.Member`</returns>
        public PageList<Data.DomainModels.Member> QueryPageList(int page, int size) { }

        /// <summary>
        /// 保存会员信息
        /// </summary>
        /// <param name="model">会员实体对象</param>
        /// <returns>true,操作成功;false,操作失败</returns>
        public bool Save(Data.DomainModels.Member model) { }

        /// <summary>
        /// 会员登录
        /// </summary>
        /// <returns>Service.Module.ResultEnum.LoginResultEnum</returns>
        public Service.Module.ResultEnum.LoginResultEnum Login()
        {
            return ResultEnum.LoginResultEnum.Success;
        }
    }

 

posted @ 2014-12-02 16:29  ml-virus  阅读(270)  评论(0)    收藏  举报