华为云首页用户手册

数据仓库服务 GaussDB(DWS)-PL/pgSQL使用:书写规范

时间：2023-11-01 16:15:35

数据仓库服务 GaussDB(DWS) 开发设计建议

书写规范

变量命名规则：
1. 过程、函数的输入参数格式宜为：IN_参数名，参数名宜使用大写。
2. 过程、函数的输出参数格式宜为：OUT_参数名，参数名宜使用大写。
3. 过程、函数得输入输出参数格式宜为：IO_参数名，参数名宜使用大写。
4. 过程、函数得程序中用到的变量宜由v_变量名组成，变量名宜使用小写。
5. 将查询语句做成字符串拼接时，where语句的拼接变量名宜统一为v_where，select语句的拼接变量名宜为v_select。
6. 记录（RECORD）的类型（TYPE）命名宜由T+变量名组成，名称宜使用大写。
7. 游标命名宜由CUR+变量名组成，名称宜使用大写。
8. 引用游标（REF CURSOR）的命名宜由REF+变量名组成，名称宜使用大写。
变量类型定义：
1. 变量类型声明时，如果其含义和应用表某字段含义相同时，应使用%TYPE声明。
2. 记录类型声明时，如果其含义和某应用表行数据相同时，应使用%ROWTYPE声明。
注释规范：
1. 注释应该是有意义的，而不应是重述代码。
2. 注释应简洁、易懂，以中文为主。为了表达准确，名词或操作上也可以使用英文。
3. 应在每个存储过程、函数得开始加入注释，内容应包括：本程序的简要功能描述、编写者、编写日期、程序版本号信息和程序变更信息，而且各存储过程开头注释应保持统一格式。
4. 应在输入输出参数的旁边添加注释，注明次变量的意义。
5. 每个块或大分支的开始宜添加注释，描述块的简要功能，若使用算法，宜添加注释简单描述算法的目的和结果。
变量声明格式：
每行应只包含一条语句，如同时需要赋初始值，应在同一行书写。
大小写规范：
除了变量名，应一律使用大写。
缩进规范：
创建存储过程语句中，同一层的CREATE、AS/IS、BEGIN、END这几个关键字应位于同一列，其他部分依次缩进。
语句详述：
1. 变量定义语句。每行应只包含一条语句。
2. 同一层的IF、ELSEIF、ELSE和END关键字应开始于同一列，执行语句缩进。
3. CASE和END关键字应位于同一列，WHEN和ELSE关键字应缩进。
4. 同一层的LOOP和END LOOP关键字应位于同一列，层内语句或嵌套应依次缩进。