#javadoc
#Javadoc
Вопрос:
У меня возникает соблазн написать что-то вроде следующего:
StringBuilder.append(String.format("%d %f", x, y));
Но я знаю, что я действительно работаю с экземпляром StringBuilder, и я не имею в виду вызов статического метода добавления. Существует ли общепринятый способ написания такого Javadoc или псевдокода?
Ответ №1:
Я хотел бы написать StringBuilder#append(...) здесь, чтобы указать, что это метод экземпляра, который вызывается в экземпляре StringBuilder, а не метод класса (статический), в отличие от метода класса, подобного String.valueOf(...) .
Однако я не уверен, что по этому поводу существует определенное соглашение.
Комментарии:
1. Этот вопрос (и мой ответ) касается использования разных обозначений для статических и нестатических членов, а не использования
#в@seeтегах Javadoc (где вы используете его как для статических, так и для нестатических членов). Я уточнил свой ответ, чтобы прояснить это.