代码开发规范-优快云博客

本文链接：https://blog.youkuaiyun.com/m0_64858032/article/details/145674441

1.java代码中的命名规则、注释规则

命名规则

1.代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束，例如__name,$name等等

2.代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

3.类名使用 UpperCamelCase 风格，开头字母必须大写，后每一个单词的首字母大写，必须遵从驼峰形式

4.方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，第一个单词小写，后每一个单词首字母大写，必须遵从驼峰形式

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

6.中括号是数组类型的一部分，数组定义如下：String[] args;

7.包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。

8.杜绝完全不规范的缩写，避免望文不知义。

注释

●.注释的双斜线与注释内容之间有且仅有一个空格例如：// 注释内容

●.类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用// xxx 方式。

●.所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

●.所有的类都必须添加创建者和创建日期。

●.方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释

●.使用/* */注释，注意与代码对齐。

●.所有的枚举类型字段必须要有注释，说明每个数据项的用途。

●.代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改

接口增删改查的方法命名：

新增	insertXxx
删除	deleteXxx
修改	updateXxx
查询列表	queryXxx
查询单条	getXxx

2.Oracle表、字段、键、索引、函数、存储过程命名规则

2.1.表

表

名称长度不超过 20 位，表以 T 开头先按主题代码取名，再按用途命名，表名多个单词之间使用“_”分隔，主题代码如下表：

主题	代码	备注
基础表	TB	系统基础表，如：币种、交易市场、数据字典、产品信息、资产类型等
风控表	TR	风险引擎、风险工作台、风险条目同步等风险系统功能表，如：条目信息表、指标表等
投资表	TI	投资业务信息表，如：证券持仓表、存款表、回购表、指令信息、委托交易表、实时成交表等
资讯表	TN	资讯数据信息表，如：证券信息、债券属性、发行人信息、银行信息、证券行情等
日志表	TL	系统日志信息表，包括：功能日志、用户操作日志、错误日志等
历史表	TH	数据归档表，有些表需要每天归档，历史表和当前表一致，多了归档日期
临时表	TT	系统功能使用的临时表
中间表	TM	ETL过程中，使用的中间表

B:base 基础

R:risk 风控

I:invest 投资

N:news 资讯

L:logs 日志

H:history 历史

T：temp 临时

M：middle 中间

2.2字段

总长度不超过 20 个字符，开头首字母为字段类型代码，字段类型代码见下表：

字段主题	类型	代码
字符	CHAR/VARCHAR2	C
日期、时间	NUMBER(8)	D
数值	NUMBER	N

字段长度、精度说明：

字段类型	字段长度、精度
字符	1）明确具体长度的，按实际长度设置；2）不明确具体长度，按：20/50/100/200/500/1000/2000/4000，这几个档位进行设置；
日期、时间	字段类型长度、精度：NUMBER(8)
数值：金额类（含指令、委托、成交、成本、利息等金额）、数量类	字段类型长度、精度：NUMBER(22,6)
数值：价格类（含指令、委托、成交价格、T日百元应计利息等）	字段类型长度、精度：NUMBER(22,12)

number数据类型总结

下面是对 NUMBER(精度, 比例) 数据类型的总结，以表格形式呈现：

类型定义	含义	允许的数值示例	不允许的数值示例
`NUMBER`	无精度和比例限制，可存储任意大小的整数或小数。	`12345678901234567890` `123.4567890123456789`	无限制
`NUMBER(n)`	总共 `n` 位有效数字，不限制小数位数。	`12345678` `12.34567`	`123456789`（超出总精度，number(8)）
`NUMBER(p, s)`	总精度为 `p`，小数部分为 `s` 位。	`1234567890123456.123456`（精度 22，比例 6） `123.4567`	`12345678901234567890.123456`（超出精度 22 或比例 6）

2.3.键

以PK开头 PRIMARY KEY

以FK开头 FOREIGN KEY

2.4索引

以IDX开头。INDEX

2.5.函数

以FN开头：代码段、二级段用途同存储过程

2.6.存储过程

以SP开头：（stored procedure）（存储过程）

代码段	用途	举例
9900	系统公共的过程	SP_9900_PRO_LOG
9901	导入数据的过程原则上按目标表名创建过程，对于一些复杂的数据，如证券信息，可以有子过程，分别导入债券的证券信息、股票的证券信息等	SP_9901_IMPORT，导入数据入口；SP_9901_TN_STOCK_BOND，导入债券的证券信息;SP_9901_TN_STOCK_A，导入A股的证券信息；
9902	同步条目的过程	SP_9902-HSRISK_IMPORT
9903	风险应用程序的过程	SP_9903_XXXXXX
9904	衍生数据的过程例如，根据评级明细衍生1年内孰低评级等该部分统一管理	SP_9904_PROCESS，衍生数据入口；
9905	处理外部的指令数据，非指令计算请求的数据该部分统一管理	SP_9905_XXXXXX
9999	临时性的过程	SP_9999_XXXXXX