2
Предположим, у меня есть интерфейс следующим образом.Если методы реализации имеют комментарий JavaDoc, если интерфейс, который они реализуют, имеет комментарий JavaDoc
public interface MyInterface{
/**
* This method prints hello
*/
void sayHello();
/**
* This method prints goodbye
*/
void sayGoodBye();
}
Конкретный класс реализует эти методы. Теперь методы в конкретном классе также должны определять javadocs поверх определения его метода? Я вижу, что некоторые люди просто копируют одно и то же определение javadoc в реализованные методы конкретного класса. Я не считаю это хорошей практикой, потому что, если мы хотим изменить определение документа, нам нужно изменить его в нескольких местах.
Какова стандартная практика для этого?
В интерфейсе, где вы объявляете методы, может быть обзор того, что делает этот метод. При реализации, если требуется, вы можете поэтапно объяснить метод, чтобы узнать, что именно делает этот метод. В идеале, если вы используете правильный стандарт кодирования, его не требуется, чтобы дать такое подробное объяснение. – Raghuveer
Вы хотите сказать, что метод интерфейса javadocs должен быть кратким? – DesirePRG
Да, но и достаточно описательно, чтобы понять читателя, что API должен делать. – Raghuveer