Javadoc-记录POJO

时间:2018-11-28 13:33:42

标签: spring jpa javadoc pojo

我需要记录/ java-doc POJO中的实体。例如,如果有一个列实体

@Column(name =“ id”) 私人Long ID;

“ id”列的记录方式应使其具有该列及其约束的基本描述。 java-doc中是否有可用的注释技术来实现此目的

1 个答案:

答案 0 :(得分:0)

实体是代码,而不是源代码,因为它们不是“源”,这些实体是真实源(数据库结构)的副本(可以说是镜像)。

请记录源代码,因为源代码是数据库,您应该使用数据库的注释功能。

oracle中的示例:

COMMENT ON COLUMN employees.job_id IS 'abbreviated job title';

https://docs.oracle.com/cd/B28359_01/server.111/b28286/statements_4009.htm#SQLRF01109

不幸的是,这是ASCII而不是热门的Javadoc。

这种方式:

  1. 数据库工程师一定不知道如何编写Java和
  2. 您有一个跨学科团队。