Лучший способ комментировать код на Java

Question

Какой лучший способ комментировать код в Java, есть ли способ автоматически генерировать имя функции и параметры в Eclipse?

Например, я пишу эти комментарии вручную:

// <summary>
// Some comments about the function
// </summary>
// <param name="id">the user ID</param>
// <param name="username">The user password</param>
// <returns></returns>
public Connect(int id, String password)
{

}

Спасибо уже.

Answer 1

Взгляните на Javadoc

Javadocs могут быть легко созданы в Eclipse. Вы можете ввести /**, и он будет автоматически заполнен. Вы также можете настроить шаблоны кода для автоматической генерации javadocs.

Answer 2

Выберите метод, для которого вы хотите, чтобы комментарии и нажмите SHIFT , ALT и J вместе.

Найдите время, чтобы узнать оJavaDoc также является очень богатой областью для документирования вашего кода.

Answer 3

По соглашению это способ сделать это:

/** Some comments about the function
  * 
  * @param id the user ID
  * @param username The user password
  *
*/
public Connect(int id, String password)
{

}

Если ваш метод возвращает что-либо, вы должны добавить `@return 'с последующим объяснением.

Ваша среда разработки и стандартная утилита JavaDoc смогут ее проанализировать.

Answer 4

В этой ветке, похоже, есть путаница. Последовательность клавиш, которую я использую для создания комментариев Javadoc: SHIFT + ALT + J not CTRL ?

Answer 5

Лично я предпочитаю использовать JAutodoc плагин для комментирования.Посмотрите на это.Хорошо.

Answer 6

Я бы сказал, что лучший способ комментировать код в Java - это предоставить значимые имена для ваших методов и имен переменных:)

class MyService {
    public void authenticateUser(int userId, String userPassword) {...}
}

Answer 7

Вам нужно одновременно нажать CTRL + ALT + J с курсором на строке объявления.

Answer 8

Лучший способ - использовать JavaDoc, и eclipse имеет встроенные шаблоны кода для этого.

Если вы хотите иметь формат, который вы показали здесь, то вы можете написать свои собственные шаблоны. Функциональность шаблонов позволит вам вставлять переменные, одной из которых будет имя метода.

Answer 9

Лучший способ - использовать формат комментариев Javadoc, а не тот, который вы указали в вопросе.

В Eclipse наведите курсор на имя метода и нажмите Ctrl + Alt + J .Он сгенерирует вам комментарий Javadoc со всеми перечисленными параметрами.

Вы также можете контролировать способ создания комментария Javadoc в Window -> Настройки -> Java -> Стиль кода -> Шаблоны кода -> Комментарии