Javadoc - Документирование POJO - PullRequest
Новая
       15

Javadoc - Документирование POJO

0 голосов
/ 28 ноября 2018

Мне нужно документировать / java-doc сущности в POJO.Например, если существует сущность столбца

@ Column (name = "id"), частный длинный идентификатор;

Столбец id должен быть задокументирован таким образом, чтобы он имел базовое описание.столбца и его ограничений.Есть ли какие-либо методы комментирования, доступные в java-doc для достижения этого

1 Ответ

0 голосов
/ 28 ноября 2018

Сущности - это код, но не исходный код, поскольку они не являются «источником», а сущности являются копией (скажем, зеркалом) реального источника - структуры базы данных.

Пожалуйста, документируйте источник, поскольку источником является база данных, вам следует использовать функции-комментарии базы данных.

Пример в 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. у вас есть междисциплинарная команда.
...