Чи слід змінювати ім’я автора у файлі класу, якщо я вносив більше 80% змін?

Я переробляю існуючий набір тестових класів java для автоматизованих тестів на інтерфейс користувача. Часом я закінчую внесення масових змін у файл класу або повністю оновлення його. Це змушує мене думати, що коли я переписую весь клас, то чи слід змінювати ім’я автора в розділі коментарів на моє?

Я жадібний? чи буде корисно, щоб хтось побачив моє ім’я та запитав мене у разі сумнівів?

Це дійсно залежить ...

Якщо ви думаєте, що є невеликий шанс, що хтось інший пізніше може зацікавитись у запитанні оригінального автора, вкажіть його ім’я в коді. Якщо ви думаєте, що комусь може бути цікаво запитати вас особисто, вкажіть своє ім’я. І якщо ви думаєте, що може бути можливим і те, і інше, дайте обидва імені (або коментар на кшталт "на основі роботи ...").

Звичайно, коли використання контролю над джерелами є обов'язковим на вашому робочому місці, і це єдиний спосіб отримати доступ до джерел, тоді збережіть шум і викресліть кожен коментар автора з джерела. Наприклад, на моєму робочому місці у нас є безліч вихідних файлів у контролі джерел, де ми не намагаємось записувати будь-які імена у джерела. Якщо я хочу знати, хто відповідає за файл, чи був у минулому, чи за певну зміну, TortoiseSVN легко створить мені журнал для цього.

З іншого боку, у нас є багато макросів VBA, написаних одними хлопцями, переданих іншим хлопцям (деякі з них покинули компанію впродовж багатьох років) і були багато модифіковані, все без використання джерела контролю. На щастя, коментарі до цих файлів часто містять імена авторів та якийсь журнал історії.

Я щойно наштовхнувся на інший пост, де ОП запитував, чи має ім’я автора навіть у заголовку файлу, і здається, що принаймні 2/3 людей, які відповіли, сказали, що це ім’я навіть не повинно бути перелічене та що ви повинні використовувати контроль версій, щоб просто слідкуйте за тим, хто змінив файл. Не знаю, що сталося з цією посадою, але зараз я не можу її знайти. <- (звідси анонімний "ОП")

Особисто я вважаю автора, вказаного у заголовку файлу, корисним, але з дещо іншої причини (і це може не стосуватися інших у їхньому середовищі). Незважаючи на те, що ми намагаємося практикувати право власності на громаду та часто працюємо над різними частинами проекту, ми, як правило, не маємо членів команди, які знають певні області коду набагато ближче, ніж інші. Тож, коли хтось (особливо численні підрядники, які приходять і йдуть), відкриває файл, якого вони ніколи не бачили, автор стає людиною, що переходить до нього. Він може бути не єдиним учасником або навіть учасником більшості, але, маючи своє ім’я вгорі, він визнає певну відповідальність за поширення знань / інформації про код іншим колективом. Ми можемо перерахувати в заголовку більше однієї людини - це багато людей, які дійсно зробили свій внесок і відчувають відповідальність.

Мені здається, що мені шкода, коли у мене є питання щодо файлу і доводиться вдаватися до контролю версій, щоб визначити первинну чи найбільш обізнану особу. Тоді в кінцевому підсумку переходьте від одного хлопця до іншого, оскільки всі вони заперечують дійсно знаючи, що робить код ... їм просто потрібно було зайти і виправити помилку чи дві.

Ця практика працює в нашій команді, тому що ми не маємо подачі. Якщо людина не кине або не перейде до іншої команди, цей код / ​​проект буде залишатися з людиною та з нашою командою. Очевидно, якщо люди, які підтримують код, не такі, як ті, що його пишуть, то нікого не хвилює, хто був вказаний у заголовку.

Тож, зважаючи на мій погляд на заголовки файлів, я б сказав, що якщо ви змінили 80% файлу, і ви відчуваєте, що зараз ви - хлопець з будь-яких питань (і ви, мабуть, повинні відчувати це так), так, переходьте заздалегідь та оновіть заголовок файлу, щоб мати своє ім’я. Якщо ви погано відчуваєте видалення попередньої людини, ви можете залишити їх ім’я там, принаймні, поки що. Ви завжди можете запитати оригінального автора, і я впевнений, що вони не заперечуватимуть один біт про те, що ви змінили ім'я, оскільки я припускаю, що немає жодних важких відчуттів щодо зміни 80% самого файлу.

ОНОВЛЕННЯ: Знайдено цю публікацію . Поняття не маю, як мені вдалося щось тягнути назад із серпня. Щойно я закінчив читати «Прагматичного програміста», і в останньому розділі автори розповідають про підписання роботи та підзвітності (в іншому дописі це було зазначено, тому я і подивився). Книга має ідеальний сенс, і тепер, коли я думаю про це, можливо, ми повинні запровадити командну політику, щоб той, хто вказаний як автор, повинен бути включений до всіх оглядів коду відповідного файлу. Неважливо, хто останній або найбільше змінив файл у SVN, автор є власником і зберігачем.

Ім’я автора не вважаю надзвичайно корисним. Як показує це запитання, часто немає жодного автора, тому назвати «автора» неможливо.

Можна, звичайно, включити список усіх людей, які зробили основні внески, але це вже можна отримати з журналу контролю ревізії - тож який сенс?

У моєму проекті немає інформації про автора в більшості файлів. Якщо у вас є питання, ви просто заглядаєте в журнали, і зазвичай очевидно, що одна-дві людини виконали більшу частину роботи, тому ви їх задаєте.

Редагувати

Відповідь передбачає проект, використовуючи контроль версій. Якщо ви (послідовно) не використовуєте VC, то введення автора (списку) і, можливо, деяка історія змін у файлі може бути життєздатним вирішенням. Тим не менш, ви, ймовірно, повинні почати використовувати VC якомога швидше, і в цьому випадку див. Вище :-).

Якщо файл істотно модифікований, слід прийнятно додати своє ім’я у файл, як хтось, хто щось знає про нього.

Творець вихідного файлу повинен / повинен завжди (IMHO) згадуватись у вихідному файлі. Це, з гарним коментуванням заголовка, повинно показати, чому автор розробив джерело і яке його мислення було для написання коду. Що стосується сервера, що підтримує код, то для відстеження керування джерелом вирішальне значення має додавання імені утримувача.

Ім’я автора, IMHO знову, повинно включати вихідну версію коду, поза системою контролю версій, першу дату, коли відбулася зміна, а також номер запиту на зміну. Причина полягає в тому, що якщо рішення про зміну VCS виникає, є історія версії коду, ким був автор, а також номер запиту на зміну, на який можуть посилатися розробники (якщо їм потрібно знати, чому саме сервіс робив те, що він / вона зробила). Таким чином, в нашій організації наш формат такий:

/**
 * $comment
 * <p />
 * $cr_number, $date, $author, $description 
 **/

Мені подобається бачити ім'я оригіналу автора, якщо тільки знайти когось, щоб розпочати мої пошуки відповідей про код. (У автора зазвичай немає спогаду, але це принаймні кадр!)

Я рекомендую просто додати своє ім’я нижче оригіналу автора.

Не потрібно замінювати прізвище іншої людини, оскільки вони можуть знати деякі аспекти первинної потреби бізнесу, яких у вас немає, та інші, що слідують після того, як вам може знадобитися поговорити з цією людиною.

Моя політика щодо коментарів @author:

1. Якщо це абсолютно новий файл, я ставлю себе як @author.
2. Якщо це вже наявний файл, я залишаю @author у спокої, незалежно від того, що я роблю для файлу.

Якщо у вас є питання щодо чогось, не має значення, хто такий автор @author - це важливо, хто @author, яку частину файлу ви редагуєте. Ось для чого [git/svn/whatever] blame.

IMO, @author потрібно піти.