документация и камменты кода


документация и камменты кода

Пост madkoder » Пт май 22, 2009 2:45 am

Комментировать код нужно и важно, это обязательно надо делать. Особенно какие-то нетривиальные моменты в коде, которые трудно понять с ходу. Но общая документация в больших проектах зачастую устаревает, её почти невозможно поддерживать в 100% актуальном состоянии. Поэтому некоторые вот товарищи раздули целый флейм на тему "лучшая документация это сам код" и даже книжку на эту тему посоветовали.

По мне так правило должно быть такое: свой код тщательно комментируй и по возможности поддерживай документацию, но с чужим будь готов к полному отсутствию оной. Зачастую наиболее "талантливые" и "творческие" личности на такие детали полностью забивают, так что иногда приходится разбирать всё с нуля...
Картинка участника
madkoder
Site Admin
 
Постов: 149
Зарегистрирован: Сб мар 22, 2008 4:55 am

Обратно - Организация разработки, управление проектами

  • Последние темы на сайте
  • Другие форумы

  • Кто сейчас на нашем сайте

    На этом форуме сейчас находятся: анонимно: 0