Комментарии к интерфейсу JavaDoc [закрыто]

Закрыт . Этот вопрос основан на мнении. В настоящее время он не принимает ответы. Подробнее .

Хотите улучшить этот вопрос? Обновите вопрос, чтобы на него можно было ответить с помощью фактов и цитат, отредактировав это сообщение .

У меня есть интерфейс A, в котором есть методы x, y и z. Я комментирую класс следующим образом:

/**
 * 
 * A.java
 * Interface class that has the following methods.
 * 
 * @author MyName
 * @since mm-dd-yyyy
 */

public interface A {

    //method description for x
    void x();

    //method description for y
    void y();

    //method description for z
    void z();
}

Это правильно, или мне следует добавить другие вещи в КОММЕНТАРИИ К КЛАССУ?

Комментарии к интерфейсу JavaDoc [закрыто]

0 ответов

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