Как объяснить предложение публичного класса в Javadoc

Question

Привет, меня попросили объяснить цель каждого открытого класса, общедоступного метода и открытого поля в моей программе, но я не знаю, что написать, например, @param только для методов?

Можете ли вы привести пример каждого класса, метода и поля для javadoc, пожалуйста?

Answer 1

Если вы используете Eclipse, введите /** и нажмите ввод непосредственно перед объявлением метода или класса, которое вы хотите документировать.
Для каждого метода/класса появятся соответствующие анотации, и вы можете написать подробности метода/класса.
При нажатии ctrl+space внутри этой области вы можете увидеть все доступные варианты @ для целей документирования

Answer 2

Первый here is the oracle tutorial.

Стандартный способ:

/** 
* This class does XYZ, here goes a description of your class 
* @author Alex Jj 
* @version 1.0 
*/ 

Стандарт:

В верхней части файла .java, включают в себя авторскую лицензию.

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

• Затем добавьте @author тегов , по одному на автора, это обычно ваше полное имя. Это необходимо.

• После этого, у вас есть @version тег, это требуется

• После этого, как правило, теги, как @see (относится к другим классам, которые имеют отношение)

• с последующим @since который является первая версия Java, которую вы поддерживаете

Для примера here is how java.lang.String is documented.