Достаточно ли добавления метаинформации для включения меня в качестве дополнительного @author класса?

#java #jpa #javadoc

#java #jpa #Javadoc

Вопрос:

Я и мой коллега находимся в процессе разработки модели предметной области для небольшой части нашего проекта. Недавно он передал скелетные классы сущностей в наш репозиторий SVN без добавления аннотаций JPA. В то же время я разработал физическую модель данных и создал соответствующие объекты базы данных. Теперь мне нужно сопоставить классы сущностей с базой данных, принимая различные решения о стратегиях наследования и других вещах. Квалифицирует ли меня аннотирующие классы как дополнительные @author ? Я знаю, что обычно дополнительный @author тег может быть добавлен, когда в класс были внесены некоторые важные изменения. Но что, если я предоставлю только метаинформацию?

Редактировать:
Дело не в эго. Речь идет о том, распространено ли это и считается ли хорошей практикой.
Некоторые говорят, что теги @author бесполезны, поскольку код в любом случае находится под контролем версий.
Но я лично так не думаю. Этот тег может быть весьма полезен в некоторых случаях.

Комментарии:

1. Я не знал, что существуют какие-либо «квалификации». Или что кто-то действительно использовал тег для чего-то конкретного, поскольку информация об изменении файла в SCCS уже сообщает, кто изменил файл. В любом случае ответ на этот вопрос абсолютно произвольный и зависит от вашей организации.

2. @author Достаточно ли редактирования для включения меня в качестве дополнительного @author класса?

Ответ №1:

Я всегда добавляю @author в классы, я тоже вношу существенный вклад. Я сталкиваюсь со многими случаями, когда коллега создавал скелеты или что-то неполное, где я также добавил себя в качестве @author .

Для меня это не эго, а скорее краткая справка для кого-то другого, кому нужно просмотреть файл без необходимости возвращаться к журналам контроля версий, если им нужна информация.

Комментарии:

1. Полностью согласен с вами. Я думаю, что действительно важно поддерживать список @author в актуальном состоянии, чтобы вы могли быстро узнать, с кем связаться, если у вас возникнут вопросы. Анализ SVN может занять гораздо больше времени, особенно если класс имеет большую историю.

Ответ №2:

Не позволяйте эго мешать программному обеспечению. Вам действительно все равно?

В любом случае, разработка аннотаций JPA, иерархий и связанного с ними кода намного сложнее, чем создание скелетных сущностей, поэтому, если вам действительно не все равно, добавьте его.

Обратите внимание, что ваш VCS будет отслеживать, кто вносит какой вклад в какую работу, поэтому всегда будет одна точка истины для того, кто поместил какой код в приложение.

Ответ №3:

На мой взгляд, можно добавить себя как @author . Настройка аннотаций JPA может быть не такой простой. Если вы не уверены, спросите своего коллегу. Имея SVN (и отдельные учетные записи), легко выяснить, кто что сделал.

Комментарии:

1. Как писал hvgotcodes: вам действительно все равно? Я бы предпочел коллективное владение кодом вместо пометки автора.