Как лучше всего обрабатывать / форматировать документацию Javadoc и аннотации в коде? [дубликат]

На этот вопрос уже есть ответы здесь :

codestyle; поместить javadoc до или после аннотации? (5 ответов)

Closed 6 лет назад .

Я просмотрел этот форум, и я погуглил, и я ' Я не уверен, как лучше всего обрабатывать Javadoc и аннотации, которые появляются вместе в одном классе.

Судя по тому, что я вижу из документации Sun / Oracle, они, кажется, предлагают (хотя я не могу найти явного утверждения), что Документация Javadoc должна быть указана поверх аннотаций.

См. Их пример Как и когда прекращать использование API .

Это отлично работает для чего-то простого, например @Deprecated или @Override. Но как насчет использования JPA и / или Hibernate? Ваши классы и методы должны быть аннотированы несколько более сильно (иногда две или более аннотации на класс или метод).

Я предполагаю, что Javadoc все еще находится поверх аннотаций?

Также мне интересно, как лучше всего использовать аннотации использоваться? Я видел несколько примеров, когда аннотации «складываются» поверх класса, члена, метода. И я видел другие, где они перечисляли аннотации в одной строке (обычно это метод).

Что лучше? Что более читабельно?

И вы «документируете» тот факт, что вы аннотировали что-то в своем Javadoc или нет?

Я ищу либо хороший набор документации об этом, либо ваш собственный опыт о том, что наиболее удобен для чтения / сопровождения.

задан Chris Aldrich 8 August 2011 в 14:11

0 ответов

Другие вопросы по тегам:

java formatting annotations javadoc code-documentation

Как лучше всего обрабатывать / форматировать документацию Javadoc и аннотации в коде? [дубликат]

0 ответов

Похожие вопросы: