Как документировать (javadoc) метод обработчика сообщений? - PullRequest
Новая
       5

Как документировать (javadoc) метод обработчика сообщений?

0 голосов
/ 27 сентября 2011

У меня есть класс, который реализует Handler.Callback

Итак, в моем коде у меня есть что-то вроде этого: 

@Override
public boolean handleMessage(Message msg) {
    super.handleMessage(msg);
    switch (msg.what)
    {
        case ThreadMessages.MSG_1:
        {
            break;
        }

        case ThreadMessages.MSG_2:
        {
            break;
        }

        case ThreadMessages.MSG_3:
        {
            break;
        }

        case ThreadMessages.MSG_4:
        {
            break;
        }

        case ThreadMessages.MSG_5:
        {
            break;
        }

    }
    return false;
}

Как мне прокомментировать этот методотражать сообщения, которые может обрабатывать мой класс?

Цель здесь - дать разработчику понять, какое сообщение он может отправить классу без необходимости читать исходный код, просто используя документ Java.

Спасибо

Ответы [ 2 ]

1 голос
/ 27 сентября 2011

Мой совет:

В классе ThreadMessages Переименуйте MSG_1 и другие статические поля для некоторых значимых имен.

Над вашими handleMessage

Добавьтеследующие комментарии: 

/**
 * Can handle {@link ThreadMessages#MSG_1}, {@link ThreadMessages#MSG_2}, {@link ThreadMessages#MSG_3}, {@link ThreadMessages#MSG_4}, and {@link ThreadMessages#MSG_5}
 */

И в классе ThreadMessages

Объясните каждое статическое поле, добавив над ним 

/**
 * this is used for
 */
0 голосов
/ 27 сентября 2011

У Oracle есть отличный документ о том, как комментировать ваш код, чтобы вы могли генерировать документы Java позже.

...