# CMS开发

**Repository Path**: yang-fenghao/cms-development

## Basic Information

- **Project Name**: CMS开发
- **Description**: 完成cms开发的仓库

- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 5
- **Created**: 2022-07-15
- **Last Updated**: 2022-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# CMS开发

## 开发规范
### 命名规范
命名规范：

不能以下划线或美元符号开始，也不能以下划线或美元符号结束
- 反例： _name / __name / O b j e c t / n a m e _ / n a m e Object / name\_ / nameObject/name_/name / Object$


### 类名规范：

类名使用 UpperCamelCase 风格，必须遵从驼峰形式。
但以下情形例外： （领域模型的相关命名 ）DO / BO / AO / PO / DTO / VO / DAO等。
- ①正例： MarcoPolo / UserVO /
- ②反例： macroPolo / UserVo/

Service /DAO接口类名必须以字母 I 开头，实现类必须 Impl 结尾

- ①正例： IUserDAO / UserDAOImpl /
- ②反例： UserDAO / UserDAO /

根据类命名时体现它用途、设计模式。（推荐）


方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式：

- 正例： localValue / getHttpMessage() / inputUserId
- 反例： localvalue / gethttpmessage() / inputuserid

禁止使用xxPO作为临时变量。

**常量命名全部大写，单词间用下划线隔开：**

- 正例： MAX_STOCK_COUNT
- 反例： max_stock_count

DAO中sql的常量必须为：SQL +下划线+对应方法名的大写下划线分割单词的形式 例如：private static final String SQL_FIND_USER_INFO=“”;


### 注释规范
注释格式：

接口注释必须写清楚接口的用途、传参、返回数据、创建人、创建日期等信息

类注释要写明类的用途

在方法内的注释，首先要写明方法的主要功能，将功能分成123…步骤，并将这些步骤写在注释用，方便接盘侠更好的读懂代码，了解写代码人的思路。

~~~c#
/**
 - 获取该用户所在部门下的用户(不包括子部门的用户)
 - @param orgId  机构ID
 - @param userId 当前登录用户ID
 - @return 
 - @throws Exception
 - @throws BaseException
 - @author Xiang Dejun
 - @2014-12-26
*/
~~~


### 数据库表规范

表命名请使用T_ 开头

使用efCore进行开发，使用配置文件进行配置表关系，请勿使用约定



### git提交

**请务必写好commit注释，这非常重要**