парное программирование с комментариями

Question

За эти годы я обнаружил, что программисты, работающие по принципу экологичности, склонны читать комментарии, а не код для устранения проблем.

Увеличивает ли одно лицо документирование кода другого человека (и наоборот) с одобрения составителя кода в долгосрочной перспективе, как качество кода?

Это хорошая идея?

в сторону: я ищу золотую середину между сольным программированием и парным программированием с точки зрения бюджетирования.

Answer 1

Люди стремятся найти самое простое решение проблемы. Если доступно «человеческое» описание, оно может быть использовано до того, как читатель углубится в эзотерический код. IOW, комментарии часто будут рассматриваться первыми, независимо от того, насколько зеленым оказался программист.

Комментарии должны поддерживаться как можно лучше. К сожалению, они могут легко устареть (потому что они не могут быть проверены компилятором). Следовательно, они должны быть сведены к разумному минимуму, потому что, в конечном счете, сам код является единственным реальным комментарием , которому можно доверять.

Что касается того, кто должен писать комментарии, это зависит от того, на каком уровне пишутся комментарии. Например, на более высоких уровнях комментарии должны описывать внешнее поведение модуля и могут быть написаны большей группой людей. Внутренне, однако, комментарии должны объяснять цель различных частей кода. Таким образом, читателю будет легче подобрать манеры кода. Эти комментарии должны быть написаны кодером.

Answer 2

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

Вы можете попробовать этот подход:

• Выполните проверки кода с разработчиком, который не принимал участия в программировании.
• Проверка должна проводиться без физического присутствия автора кода. Просто рецензент, копия кода из системы контроля версий и письменная документация.
• Если рецензент не может разумно понять код без посторонней помощи, он недостаточно документирован и должен быть возвращен автору.
• Повторите при необходимости.

Answer 3

Я обнаружил, что «парное программирование» работает лучше всего, когда один человек пишет код, а другой пишет модульные тесты (работают бок о бок, чтобы они могли видеть, что делают друг друга). Вы также можете поменяться ролями.

Answer 4

Я считаю, что это работает лучше всего, когда помощник размышляет о широком диапазоне (то есть о том, чего мы пытаемся достичь), а ковбой-клавиатура размышляет о масштабе деталей. Я не думаю, что комментарии имеют к этому какое-либо отношение.

Answer 5

Я обычно пишу комментарии и пишу код сразу после этого или время от времени или время от времени. К тому времени, когда я заканчиваю писать свой комментарий, код становится очень ясным в моем сознании (спасибо факту вербализации моих идей при написании комментария). Я не люблю комментировать код, который я не написал. И всякий раз, когда я возвращаюсь, чтобы пересмотреть код, сначала прочитайте исходные комментарии, затем подумайте о новых комментариях, напишите их и напишите код рядом.