Хорошая ссылка для использования популярных тегов Javadoc?

Question

Я хотел бы использовать пользовательские теги в моих javadocs, но придерживайтесь какого-то соглашения, чтобы другим людям было легче разобраться в них. На официальной странице документации Oracle по javadoc они перечислили базовые теги, которые представляют собой небольшой набор по сравнению со списком тегов, которые появляются в подсказке кода моего редактора javadoc.

Есть ли в сети хороший справочник, в котором перечислены популярные теги Javadoc?

Answer 1

Пользователь StackOverflow Uri предоставил список пользовательских тегов, которые он предлагает в рамках своего докторского исследования эффективности javadocs как ответ на связанный вопрос .Вы можете принять их и иметь некоторую уверенность в том, что используете что-то, подкрепленное некоторыми исследованиями.

Лично я бы просто придерживался стандартных тегов javadoc и придерживался лучших практик, отмеченных в Oracle (Sun) Как писать комментарии к документу для инструмента Javadoc .

Answer 2

javadoc (Java JDK 8) : http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#CHDJGIJB

Javadoc (Java JDK 7) : http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags

Answer 3

Не совсем ответ на вопрос, но связанный:

Чтобы использовать пользовательские теги Javadoc, вы должны либо использовать пользовательский доклет (который может поддерживать любые теги, которые он хочет), используйте пользовательские теги со стандартнымdoclet или используйте параметр командной строки -tag для определения этих тегов.В противном случае вы получите предупреждение от javadoc (и никакого вывода для этого тега).

Так что действительно имеет смысл использовать пользовательские теги, когда вы уже сотрудничаете с кем-то, кто их использует, и этот кто-то скажетВы какие варианты Javadoc вы должны использовать.(Или вы сами добавляете эти опции).

Я не использую нестандартные теги, мне достаточно стандартных.

Answer 4

Я обнаружил эту ссылку с примерами тегов Javadoc