Как не нужно писать документацию

[VaiMR]

Такие комментарии пишут, когда нечего сказать о коде. Разработчик, находясь в контексте, считает комментирование таких тривиальных участков кода лишним, но комментарий нужен и он есть. Решается это либо воспитанием самодисциплины, либо рецензированием кода. «Описывайте „почему“, а не „как“ (с) П. Гудлиф.

[Pozadi]

Я так понимаю, подобные комментарии автоматически генеряться.

[denver]

(смотрит на тэги) вставлять скрипту руки? ну-ну :)

[andreycha]

Не скрипту — разработчику!

[HeadWithoutBrains]

А что вы хотели от описания гэттэра и сэттера? Описание назначения переменной явно где то в другом месте. И скорее всего, разработчику нужно было написать комментарий к обеим функциям.

[andreycha]

В том-то и дело, что нет его нигде. Часть тех же геттеров/сеттеров у них сделана хорошо — с описанием, что за поле берем/устанавливаем и что оно означает.

[VaiMR]

Я встречал такую ситуацию в одном коде. В нем разработчик дал ёмкое описание поля в приватной части класса, а для публичных get/set методов дал пространное описание «возвращает/устанавливает переменную...».

[Aquahawk]

Я с подобной штукой каждый день работаю(всего два дока, один из которых AVM2 overview). Печально но лучше чем ничего.

[steck]

Действительно ужасно. Даже тот-же GhostDoc пишет более осмысленные комментарии.

[burdakovd]

Примерно такие комментарии для get/set по умолчанию генерирует eclipse.

А что тут можно сделать?
Дублировать описание поля в комментарии для геттера и в сеттера?

Единственный вариант без дублирования — написать комментарий к полю, а у геттера и сеттера оставить сгенерированные по умолчанию. Но тут свой минус — поле наверняка приватное.