Документация Java в отдельном файле на Eclipse - PullRequest
0 голосов
/ 08 июня 2018

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

Просточтобы быть понятным, «документация», о которой я говорю, - это комментарий перед любым методом (JavaDoc), который объясняет, что делает этот метод.Его можно просмотреть, когда я наведу на него курсор, как и в случае с оператором String.

Я знаю, что эти комментарии находятся внутри класса в исходном коде Java.

JavaDoc example

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

Я уже пытался «Сгенерировать Javadoc», но, поскольку я удалил его в своем коде, средство наведения больше не работало.

Заранее спасибо.

Ответы [ 2 ]

0 голосов
/ 08 июня 2018

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

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

0 голосов
/ 08 июня 2018

JavaDocs должен быть встроенным.Это имеет смысл, когда вы думаете об этом.Если бы вы изменили сигнатуру или поведение метода, а документация для этого метода была отключена в каком-то другом файле, вы очень быстро получили бы неточную и, следовательно, бесполезную документацию.Люди забыли бы обновить его или намеренно избегали бы этого из-за хлопот.

Если длина комментариев вас раздражает, IDE, такие как IntelliJ, позволят вам свернуть JavaDocs (и любые другие блоки), чтобыскрыть их:

Before After

Прошло много времени с тех пор, как я использовал Eclipse, но я подозреваю, что это то же самое.

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


Кстати, вы готовы написать качественную документацию.Миру нужно больше таких разработчиков.

...