命名规范
数据库实体类命名规范
新功能的实体类全部由AutoCode生成。
每个数据库表都有对应的实体类,实体类的名称和字段名称需要和数据库表名和字段名一致。
实体类如果需要手动拓展表结构关联属性的话,就在同一个代码文件下里加个相同的类
利用partial语法。一般情况下,主表的entity里会增加个子表的List
示例:
namespace ToothFacModel.Entity.WareHouseMgt
{
/// <summary>
/// 订单贵金材料铸圈号明细表拓展表
/// <author>oycm</author>
/// </summary>
public partial class AfterTurning
{
/// <summary>
/// id
/// </summary>
public int ID { get; set; }
/// <summary>
/// Kind
/// </summary>
public int? Kind { get; set; }
}
public partial class AfterTurning
{
/// <summary>
/// 明细
/// </summary>
public List<AfterTurningDetails> AfterTurningDetails { get; set; }
}
/// <summary>
/// 产品明细类别
/// </summary>
public enum AfterTurning_Kind///数据库表独占枚举和表格类放在同一代码文件下,命名采用【表名_字段名】格式
{
新做=-1,
返修=0
}
}
//明细表模型和主表模型一般分2个代码文件存储的,所以这里加了解决方案路径来说明一下
namespace ToothFacModel.Entity.WareHouseMgt
{
/// <summary>
/// 订单贵金材料铸圈号明细表拓展表
/// <author>oycm</author>
/// </summary>
public partial class AfterTurningDetails
{
/// <summary>
/// id
/// </summary>
public int ID { get; set; }
}
}
视图层模型类命名规范
视图层模型对应的是页面上的数据,一般用来对应页面上各个组件的值(以及ID等数据库的数据),一般每个页面对应一个类。
类命名:页面英文名称+View
示例:NetOrderView(网络订单)
字段名称一般和数据库一致,或者为英文名称。
一般情况下视图模型中不止会定义一个类,例如有一对多关系的表单,可能会有一个主对象和一个子对象。
这里子对象的命名:主对象_子对象英文名
页面独占枚举的命名:主对象_枚举英文名称
非独占枚举可以放在数据层项目的Enum文件夹中
示例:
/// <summary>
/// 网络订单
/// </summary>
public class NetOrderView{
public int ID { get; set; }
/// <summary>
/// 订单号
/// </summary>
public string OrderNo { get; set; }
public List<NetOrderView_ProductDetail> ProductDetailList { get; set; }
}
/// <summary>
/// 网络订单产品明细
/// </summary>
public class NetOrderView_ProductDetail{
public int ID { get; set; }
}
/// <summary>
/// 网络订单产品明细
/// </summary>
public enum NetOrderView_TabType{
发货单 = 1,
退货单 = 2
}
注意:新增字段一定要写文档级注释!方便其他人维护代码!
DTO模型按照模块进行划分,放在ToothFacModel.viewModel.*的各个模块里
入参模型以Request作为后缀
出参模型以Response作为后缀