Должны ли комментарии к методам / классам применяться последовательно или только по мере необходимости?

Для единообразия я всегда применял комментарии (в форме JavaDoc) ко всем методам и классам, даже если это простые методы получения и установки или очень маленькие классы-оболочки. Но я также стремлюсь писать самодокументированный код, который часто делает комментарии излишними; т.е. писать комментарии только там, где это необходимо (и перед этим попробуйте переписать код, чтобы комментарий вам вообще не понадобился). Следовательно, эти два подхода кажутся противоречащими друг другу.

Так должны ли комментарии, которые описывают метод или класс, применяться согласованным образом, или такие комментарии должны быть написаны только тогда, когда смысл не полностью ясен из определения?

1
задан gablin 18 September 2010 в 08:46
поделиться