?

Log in

No account? Create an account
November 2016   01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
cartoon

Миф о документации, продолжение

Posted on 2011.06.18 at 23:06

Comments:


Gaperton
gaperton at 2011-06-18 20:24 (UTC) (Link)
> С JavaDoc всё довольно просто: not tested - not implemented

JavaDoc проверяется ревьювером, этого достаточно. Предполагается, что программист до этого протестировал код, прогнал регрессию (если есть), и написал своих тестов (если так принято) - тесты тоже проверяются.

Учитывая, что в JavaDoc пишется "контракт" функции или класса, а не реализация - никакой "дырки" в процессе я не вижу. Ее нет.
Яков Сироткин
yakov_sirotkin at 2011-06-18 20:47 (UTC) (Link)
А если контракт поменялся, а JavaDoc - нет?
Gaperton
gaperton at 2011-06-18 20:53 (UTC) (Link)
Ревьювер должен проверить. Он разделяет ответственность за коммит - забыл?

Впрочем, я не сторонник этих тулов, ИМХО они мало чего добавляют к коду. Потому и написал в соответствующем пункте - "для маньяков".

Но если есть желание обеспечить их актуальность - это можно сделать.
Previous Entry  Next Entry