数据库注释规范

7.1 表
表名必须加描述，说明表的中文名称和用途。
comment on table [表名] is ‘[描述信息]’;
例如：comment on table USER_INFO is ‘用户信息表，用来保存用户的基本信息’;

7.2 字段
字段名必须加描述，说明字段的中文名称和用途，外键字段需要详细描述相关联的表，标识字段需要详细描述每个值所代表的含义。
comment on column [表名].[字段名] is ‘描述信息’;
例如：comment on column USER_INFO.TYPE is ‘用户类型：1-普通用户、2-VIP用户、3-超级VIP用户。’;
7.3 函数、存储过程
要包含：用途、作者、创建时间、修改时间、修改内容、修改人、所属开发组。
例如：

函数、存储过程中，复杂的SQL语句应加上注释，以说明算法及功能。
函数、存储过程中，对不易理解的分支条件表达式应加注释；
函数、存储过程中，对重要的计算应加注释以说明其功能；
函数、存储过程中，对于常量及变量，应注释被保存值的含义及合法取值的范围。