JAVADOC для частных методов (BlueJ)

Я использую BlueJ, и я хотел бы создать Javadoc всего моего проекта. Я хотел бы показать частные методы на Javadoc, есть ли способ сделать это? BlueJ имеет инструмент, который делает Javadoc, но BlueJ игнорирует частные методы. Это просто конвенция? Если это конвенция, я не понимаю, почему они игнорируют "внутренние" методы,они тоже полезны.-*

6
bluej java javadoc

3 ответов

этой ссылке предполагает, что BlueJ будет генерировать только JavaDocs для общедоступных методов и классов. В частности:

ваш вывод будет содержать только информацию об общих методах и переменных

однако, согласно этому сообщить об ошибке связанный с in ответ Эндрю Томпсона, похоже, это было исправлено в версии 1.1.5 BlueJ. Фактически, согласно разделу 9.8 BlueJ Справочное Руководство, вы можете указать ровно какие параметры использовать при запуске инструмента JavaDoc путем редактирования doctool.options собственность.

по-видимому, есть 3 свойства, которые управляют поведением генерации документации:

  • doctool.command: управляет командой, используемой для создания документации, и по умолчанию имеет значение javadoc
  • doctool.outputdir: управляет сохранением сгенерированной документации и по умолчанию имеет значение doc
  • doctool.options: управляет другими параметрами командной строки, переданными команде, указанной javadoc.command, и по умолчанию установлено значение -author –version –nodeprecated –package. Обратите внимание, что путем замены -package С -private вы можете документировать все методы.

в общем, так как инструмент JavaDoc является программой командной строки, вы можете просто вызвать его самостоятельно из командной строки с чем-то вроде этого:

$ javadoc -d \path\to\output\folder -sourcepath \path\to\source\folder -private

Примечание, эта команда предполагает, что javadoc входит в Переменная среды PATH, которая обычно имеет место в большинстве установок java.

  • на -d опция дает желаемый выходной каталог
  • на -sourcepath опция сообщает инструменту JavaDoc, где найти исходный код для документа
  • на -private опция сообщает инструменту JavaDoc создать документацию для всех классов, членов и методов (так как private является наиболее ограниченной видимостью)

полный список опций, которые управляйте членами, которые JavaDoc будет документировать:

  • -public - показывает только открытые классы и члены.
  • -protected - показывает только защищенные и общедоступные классы и члены. Это значение по умолчанию.
  • -package - показывает только пакеты, защищенные и общедоступные классы и члены.
  • -private - показывает все классы и члены.

(взято из JavaDoc Документация)

изменить 0: Обновленный ответ, чтобы включить новую информацию, выведенную на свет Эндрю Томпсон

5

обычно по соглашению люди не помещают частные методы в Javadoc, потому что Javadoc предназначен для кого-то, кто потребляет ваш код. Поскольку они не могут получить доступ к частным методам нет смысла документировать их для этой аудитории.

однако инструмент javadoc имеет флаг для включения этого:

javadoc -private

будет генерировать частные методы в вашем Javadoc. Я не уверен, как BlueJ работает с этим, но, возможно, вы можете передать флаг или что-то еще.

3

ссылка в принятом ответ из статьи, написанной в 2001 году. С тех пор многое изменилось.

E. G. охота через ТОП-5 или около того ссылки для "bluej + javadocs" включает в себя ссылку на что-то, что упоминает отчет об ошибке в разрешить включение частных методов в javadoc. Описание упоминает:

сделать параметры javadoc определяемыми Пользователем (в bluej.defs) , чтобы пользователи могли включать частные методы в документация

также упоминает: 

Resolution:     FIXED

примечание: Я не использую BlueJ, но должен был пойти на охоту, когда я услышал невероятный ответ, что у крупной IDE нет возможности предложить конфигурацию такой простой вещи.

3