Обозначение нестатического метода

245
18 марта 2017, 00:17

Как следует обозначать в документации нестатический метод класса? Если статический метод можно обозначить как MainClass.main(String[] args), то как быть с нестатическим методом? MainClass::nestaticMethod() или как-то по-другому?

Речь идёт не про Javadoc, а про упоминание метода в тексте (при описании таска, например). Есть ли какие-либо общие правила для этого случая?

Answer 1

В Java сигнатура метода состоит из названия и его параметров, соответственно невозможно сделать 2 метода статический и нестатический с одинаковыми именами и параметрами.

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

  • вот это MyClass.getName() статический метод
  • а MyClass.getName()- нестатический.

Имя метода и его параметры однозначно идентифицируют метод и пояснения public/private/static/protected никак не нужны и только мешают восприятию.

В документации принято указывать <class-name>.<method(param1, param2, ...)>

READ ALSO
Objects.equals(obj1, obj2) эквивалентно obj1.equals(obj2)?

Objects.equals(obj1, obj2) эквивалентно obj1.equals(obj2)?

Равносилен ли вызов Objectsequals(object1, object2) вызову object1

339
Некорректное имя при скачивании файла Java Servlet

Некорректное имя при скачивании файла Java Servlet

Подскажите пожалуйста что не такСделал скачивание файлов

280
Определение местоположения в Сервисе

Определение местоположения в Сервисе

Дело в том что я никогда не имел дело с сервисамиИ мне сейчас предстоит такая задача

207
Как добавить в ListBox(select) строки из файла?

Как добавить в ListBox(select) строки из файла?

Подскажите, пожалуйста, как добавить в такой элемент строки из файла и вообще, возможно ли это: Пример ListBox(select)

272