Плюсы и минусы управления версиями javadoc

Мне интересно, следует ли фиксировать файлы Javadoc в репозитории SVN моего проекта.

Я читал о SVN передовой опыт, в том числе несколько интересных вопросов по SO, но ни один из них еще не был задан конкретно по обработке документации javadoc.

Сначала я соглашался с аргументами, что версией должен быть только исходный код, и я подумал, что javadoc действительно легко перестроить с помощью Eclipse или, например, из файла ant javadoc.xml , но я также подумал об этих моментах:

  • Javadoc файлы легкие, с текстовой кодировкой, и изменения в этих файлах легко отслеживать с помощью инструментов diff.
  • Представляется интересным легко отслеживать изменения в javadoc, поскольку в случае "общедоступного" javadoc любое его изменение будет вероятно, означает изменение в API.
  • Люди, желающие взглянуть на javadoc, не обязательно хотят получить весь проект и скомпилировать его, поэтому размещение его в репозитории кажется такой же хорошей идеей, как и другая, чтобы обеспечить эффективное совместное использование / отслеживание.

Что вы думаете по этому поводу? Пожалуйста, ответьте конструктивными, не субъективными аргументами. Мне интересно понять, какие сценарии случаев поощряют управление версиями Javadoc, а какие делают это плохим выбором.

6
задан Babak Naffas 7 April 2011 в 21:59
поделиться