Javadoc в Junit тестируют классы?

Question

Javadoc в Junit тестируют классы?

Действительно ли это - лучшая практика для помещения комментариев Javadoc в тестовые классы junit и методов? Или состоит в том идея, что их должно быть столь легко считать и простой, что является ненужным предоставить рассказ тестового намерения?

32

junit javadoc

задан HDave 3 June 2010 в 16:44

1 ответ

Другие вопросы по тегам:

junit javadoc

Похожие вопросы:

score 21 · Accepted Answer

Я лично использую комментарии javadoc экономно, так как я нахожу, что они увеличивают беспорядок на экране. Если я могу назвать класс, функцию или переменную более описательным способом, то я предпочел комментарий. Отличной книгой для чтения на эту тему является Чистый код Роберта С. Мартина (он же дядя Боб).

Лично я предпочитаю сделать класс и методы самоохватуемыми, т.е.

class ANewEventManager {
   @Test
   public void shouldAllowClassesToSubscribeToEvents() {
        /* Test logic here */
   }
}

Одним из преимуществ этого подхода является то, что в выходных данных junit легко увидеть, что не работает, перед просмотром кода.