Добавление описательных слов к именам полей и получателям, когда значение может быть понятно из контекста класса

Question

У меня есть класс для шаблонов HTML-селекторов, который называется Selectors. В нем я назвал поля name и age и соответствующие геттеры getName() и getAge(). Теперь это может показаться немного запутанным само по себе, но, учитывая контекст класса, я как-то полагаю, что ясно, что вы получаете значение селектора, а не значение того, что выбрано beign (то есть имя человека). Например:

Selectors webPageSelectors = new Selectors()
nameSelector = webPageSelectors.getName()

Является ли это чистым и понятным или я должен добавить такие повторяющиеся слова к именам полей и получателям, как nameSelector и getNameSelector()? Или, может быть, что-то вроде этого: webPageSelectors.getForName()?, где поле называется forName (как будто «селектор для имени»)? Спасибо!

Answer 1

Я думаю, что код понятен, если вы знаете, для чего он предназначен. Однако, если вы беспокоитесь, вы всегда можете использовать JAVA-DOC для предоставления четкой документации о том, что делает каждая функция. Это очень помогает в командах разработчиков. Плюс. nameSelector типа Selector? если это так, то да, переименование атрибутов в классе Selectors для включения типа намного проще для понимания. Если вы решите сделать последнее, просто убедитесь, что вы не делаете это с атрибутами примитивного типа.

Это всего лишь мнение, вы можете писать любые коды.