Закрытые переменные-члены в документах Java - PullRequest
2 голосов
/ 28 марта 2011

Почему закрытые переменные-члены, используемые получателями / установщиками, должны иметь свое описание, указанное в javadocs, описывающем соответствующие получатели и установщики.

Ответы [ 2 ]

3 голосов
/ 28 марта 2011

Описание приватной переменной, как здесь:

/**
 * the name of this object.
 */
private String name;

... не должно содержать описания своих методов получения и установки. Он должен содержать свойства этой переменной, инварианты (например, никогда не должны иметь значение null ) и тому подобное.


Edit: Ах, я неправильно понял ваш вопрос. Вы спросили, почему описание методов получения / установки должно содержать описание переменной, а не наоборот.

Они не должны - там даже не должно существовать такой переменной. Получатели и установщики должны описывать эффект, который они оказывают, который может включать модификацию (или извлечение) некоторого абстрактного свойства этого объекта. То, что это свойство реализовано частной переменной, не имеет значения.

2 голосов
/ 06 марта 2013

Цель JavaDocs - документировать открытый API вашего кода, чтобы разработчики могли понять, как использовать ваши классы. Его цель - не раскрывать внутреннюю работу вашего кода. Документирование частных пользователей только затруднит чтение документации по API.

Значение приватных членов представляет интерес только для тех, кто читает / поддерживает ваш код. Их цель должна быть передана через четкое, однозначное наименование и общую элегантность вашего кода. В идеале вам даже не нужны комментарии.

...