【问题标题】:Javadoc - Documenting a POJOJavadoc - 记录 POJO
【发布时间】:2018-11-28 13:33:41
【问题描述】:

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

@Column(name = "id") 私有长id;

列 'id' 应该以这样的方式记录,即它具有列及其约束的基本描述。 java-doc 中是否有任何可用的注释技术来实现这一点

【问题讨论】:

    标签: spring jpa javadoc pojo


    【解决方案1】:

    实体是代码但不是源代码,因为它们不是“源”,实体是真实源(数据库结构)的复制(可以说是镜像)。

    请注明出处,因为来源是数据库,你应该使用数据库的注释功能。

    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. 您有一个跨学科团队。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2014-08-25
      • 2018-10-14
      • 2023-03-02
      • 1970-01-01
      • 2022-08-22
      • 2020-12-26
      • 1970-01-01
      • 2011-01-02
      相关资源
      最近更新 更多