Мнения разделились по этому вопросу ...
Ребята, скажите, у вас есть метод, определенный как
public static String getTestName(JsonElement e) throws ParserException;
Как разработчик, который хочет делать правильные вещи, я хотел бы документировать это соответствующим образом. Оригинальная мысль была сказать:
«Возвращает строковое представление имени теста»
"Или действительно? Он возвращает строку? Я вижу это по сигнатуре метода, знаете ли. Не нужно повторять это, просто скажите:
«Возвращает название теста»
Так, кто это? Есть ли какое-либо значение в добавлении «Строковое представление ..» Это добавляет ясности или шума?
Я сообщаю, что вы решили.
Спасибо