Комментирование методов

261
19 августа 2017, 00:31

Допустим, есть класс, реализующий некий интерфейс. Где лучше писать комментарии к методам: в классе или в интерфейсе, или же и там, и там? Есть ли какие-либо рекомендации по этому поводу?

Answer 1

В интерфейсе всегда описываем, что реализуют наследники. Если у наследника нет отличий в деталях реализации от интерфейса, то ставим:

/**
  * {@inheritDoc}
  */

иначе более детально поясняем в комментарии.

READ ALSO
Изменить формат вывода даты

Изменить формат вывода даты

Есть объект на java, в котором есть поле типа javautil

239
Помогите разобраться со Scanner в Java

Помогите разобраться со Scanner в Java

что обозначает строка Scanner lineScan = new Scanner(line);?

377
Вставить класс из другого файла

Вставить класс из другого файла

Есть 2 java файлаВ первом имеется публичный класс Selected

221
How can i check is desktop HighContrast turned on [требует правки]

How can i check is desktop HighContrast turned on [требует правки]

I've encountered a problem where I need to know is the "HighContrast" turned on the operating system

229