2015-02-13 3 views
1

Недавно я отправился на собеседование, и мне было предложено представить пример моего производственного кода.Почему джавадоки злы и что является лучшей альтернативой?

Представлен код в комплекте с javadocs, но был допрошен интервьюером о моем выборе.

Я нахожу, что javadocs весьма полезны для понимания кода другими, и на самом деле это не такая уж большая проблема с четкостью, если я использую IDE. Может ли кто-нибудь просветить меня, почему он не может быть рекомендован, и что было бы лучшей альтернативой в указанной ситуации?

+5

Какова была точка зрения интервьюера? – MadProgrammer

+3

Не помещайте документы java и соответствующие комментарии в большом продукте * суицидальные *. – TheLostMind

+2

javadocs хороши. Важнее * то, что * и * как * вы там положили –

ответ

3

Javadocs являются не зла, и для Java это лучше вы можете сделать, чтобы должным образом документировать свой код.

Под вопросом не означает автоматически, что то, что вы сделали, является злом. Вопросы в основном проверяются, если вы уверены в том, что делаете, и если вы знаете об этом больше или вы только что догадались.

+0

Я бы вышел за рамки «лучших» и сказал, что Javadoc является * единственным * приемлемым форматом для документирования кода Java, периода. Он был установлен в качестве стандарта создателями языка. Насколько авторитет вы можете получить? –

Смежные вопросы