Каково общее правило приписывания кода определенному автору - PullRequest
Новая
       2

Каково общее правило приписывания кода определенному автору

0 голосов
/ 29 августа 2010

Обычно многие люди участвуют в процессе разработки приложений (например, проект java / j2ee).Иногда один человек (например, foo@bar.com) отвечает за написание кода для определенного файла, или некоторые другие люди могли изменить код.

Вы приписываете информацию об авторе в верхней части файла для любого пользователякто вносит изменения, подобные сценарию 2, упомянутому ниже, или просто основной автор, как в сценарии 1?Существует ли определенный порядок, в котором информация об авторе должна быть добавлена ​​при изменении? 

/**
 * @author Foo Bar, (foo@bar.com)
 *
 */

или 

/**
 * @author Foo Bar, (foo@bar.com)
 * @author Foo Foo, (foo@foo.com)
 * @author Bar Bar, (bar@bar.com)
 *
 */

Ответы [ 2 ]

4 голосов
/ 29 августа 2010

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

  • Нет претензий на "владение". Кодекс является обязанностью каждого.
  • Исходный репозиторий может точно ответить на любой вопрос о том, кто редактировал данный код, вплоть до первого дня (и, надеюсь, даже почему). Нет необходимости поддерживать это вручную.
0 голосов
/ 29 августа 2010

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

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

Это действительно зависит от ваших драйверов для документирования авторской информации.Конечно, следует отметить оригинального архитектора / инженера и любых значимых авторов, поскольку, если бы это был проект с открытым исходным кодом, вы, вероятно, хотели бы быть более строгими в этом.Будет интересно посмотреть, как другие к этому подходят.

...