Хорошая ссылка для популярных тегов javadoc для использования?
Я хотел бы использовать пользовательские теги в моих javadocs, но придерживайтесь какой-то Конвенции, чтобы другим людям было легче понять их. На официальной странице документации Oracle javadoc они перечислили основные теги, которые являются небольшим набором, по сравнению со списком тегов, которые появляются в javadoc-коде моего редактора.
есть ли хорошая ссылка в интернете, в которой перечислены популярные теги javadoc?
4 ответов
пользователь StackOverflow Uri предоставил список пользовательских тегов, которые он предлагает в рамках своего исследования PhD по эффективности javadocs как ответ, связанной с вопрос. Вы можете принять их и иметь некоторую уверенность в том, что вы используете что-то, что подкреплено некоторыми исследованиями.
лично я бы просто придерживался стандартных тегов javadoc и придерживался лучших практик, отмеченных в Oracle (Sun) Как написать Комментарии Doc для инструмента Javadoc.
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
Не совсем ответ на вопрос, но по теме:
использовать пользовательские теги javadoc, вы должны либо использовать пользовательский Doclet (который может поддержать любые теги, которые он хочет), использовать пользовательские taglets с стандарт Doclet, или использовать -tag параметр командной строки для определения этих тегов. В противном случае вы получите предупреждение от javadoc (и никаких выходных данных для этого тега).
поэтому имеет смысл использовать пользовательские теги только тогда, когда вы уже сотрудничаете с кем-то, кто их использует, и этот кто-то скажет вам, что параметры javadoc, вы должны использовать. (Или вы сами добавляете эти параметры).
Я не использую нестандартные теги, стандартных для меня достаточно.