首页 > 代码库 > Magicodes.Shop 编码规范

Magicodes.Shop 编码规范

l 主键字段统一使用Id。
l 如果状态变量的新增和修改必须编程支持,请将其定义为枚举。
l 相关业务请加上统一前缀。比如账户相关:“Account_”。
l 同一业务请创建目录进行区别。
l 如无特殊需要,请确保模型名称与数据库表名一致。
l 必填以及相关约束请使用相关特性进行设置。
l 属性注意增加[Display(Name = "显示名")]的特性以设置显示名称。
l 同一业务如果有过多字段重合,请封装相关业务基类。
l 类名、字段名参考Camel-Case命名法,即第一个单词以大写字母开始(私有变量首字母小写),第二个单词的首字母大写或每一个单词的首字母都采用大写字母。
l 请使用有意义便于理解的符合业务需要的词义进行命名。
l 不要在类属性的名称定义中包含类名,如 Book.BookTitle应该改为 Book.Title。
l 布尔变量名应该包含 Is。
l 在命名状态变量时,避免使用诸如 Flag 的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用 documentFlag,而是使用更具描述性的名称,如 documentFormatType。
l 使用全称避免缩写,除非缩写已是一种公认的约定,如URL、HTML 。

Magicodes.Shop 编码规范