- 13,091
- 20
- 8 Ноя 2022
Отец Linux раскрывает секрет идеальных заметок к релизу.
Линус Торвальдс Для просмотра ссылки Войдиили Зарегистрируйся о стиле написания комментариев к изменениям в коде. Создатель Linux подчеркнул, что одно из его главных замечаний касается использования пассивного залога, который часто делает текст менее понятным и затрудняет восприятие.
Торвальдс отметил, что старается редактировать сообщения о слиянии изменений, чтобы придать им единый стиль. В частности, Торвальдс акцентировал внимание на том, что хотя часто его правки касаются лишь пробелов и структуры текста, использование пассивного залога (Passive Voice) требует дополнительных усилий для приведения описаний в активную форму.
По мнению создателя Linux, пассивные конструкции усложняют понимание, так как создают неопределённость в отношении ответственности и скрывают важную информацию о том, кто именно выполняет действия и когда. Торвальдс призвал разработчиков избегать пассивного залога и использовать активные конструкции и императивные фразы, чтобы обеспечить ясность в описаниях.
В качестве примера Торвальдс предложил заменить фразу «В этом запросе на слияние была исправлена ошибка обработки драйвера Xyzzy» на более простую и чёткую: «Это исправление устраняет ошибку...». Подобный подход, по его мнению, улучшает восприятие и снижает вероятность недоразумений.
Призыв к улучшению стиля оформления комментариев является продолжением Для просмотра ссылки Войдиили Зарегистрируйся Торвальдса 2016 года, когда он резко критиковал разработчиков за неправильное использование знаков препинания. Хотя его тон со временем стал мягче, идея остаётся той же: ясность и простота — ключ к эффективному взаимодействию.
Линус Торвальдс Для просмотра ссылки Войди
Торвальдс отметил, что старается редактировать сообщения о слиянии изменений, чтобы придать им единый стиль. В частности, Торвальдс акцентировал внимание на том, что хотя часто его правки касаются лишь пробелов и структуры текста, использование пассивного залога (Passive Voice) требует дополнительных усилий для приведения описаний в активную форму.
По мнению создателя Linux, пассивные конструкции усложняют понимание, так как создают неопределённость в отношении ответственности и скрывают важную информацию о том, кто именно выполняет действия и когда. Торвальдс призвал разработчиков избегать пассивного залога и использовать активные конструкции и императивные фразы, чтобы обеспечить ясность в описаниях.
В качестве примера Торвальдс предложил заменить фразу «В этом запросе на слияние была исправлена ошибка обработки драйвера Xyzzy» на более простую и чёткую: «Это исправление устраняет ошибку...». Подобный подход, по его мнению, улучшает восприятие и снижает вероятность недоразумений.
Призыв к улучшению стиля оформления комментариев является продолжением Для просмотра ссылки Войди
- Источник новости
- www.securitylab.ru
