Версии Javadoc

Question

У меня небольшая проблема с нумерацией версий в моих проектах.

Скажем, например, что у меня есть 4 класса Один Два Три Четыре

Когда я впервые выпущу это программное обеспечение, оно будет помечено как версия 1.0.0

В моем комментарии к документу Java, для всех классов, у меня это как @version 1.0.0

Итак, теперь тест отправляет его обратно с ошибкой во втором классе

Я обновляю второй класс и теперь должен выпустить версию 1.0.1

Теперь я обновляю тег @version в каждом классе?

Или я в итоге просто получу кучу классов с разными номерами версий в комментариях javadoc?

Answer 1

Я думаю, что исправления ошибок не влияют на это вообще, потому что, исправляя ошибку, вы меняете только номер редакции (3-й) в номере версии. И вам не нужно указывать номер ревизии в вашем javadoc - там это бесполезно, потому что javadoc используется для описания API, и API не меняется при исправлении ошибки.

Это означает, что вы должны поставить только, например, @ версия 1.2 , а не @ версия 1.2.6

Ваш javadoc изменяется только при изменении вашего API - чем вам нужно изменить номер основной (1-й) или вспомогательной (2-й) версии, и это должно быть спроецировано в вашем javadoc.

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

Answer 2

Я считаю, что правильный ответ - это просто изменение файлов, затронутых ошибкой.

Я бы оставил версии или ревизии вашей контрольной версии. В идеальном мире скрипт будет синхронизировать версию.

Конечно, этот вопрос субъективен. Если вы намерены использовать тег версии в качестве маркетингового инструмента, то да, вы, вероятно, захотите, чтобы весь код имел одинаковую версию.