Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

авторскиe комментарии - это плохо #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

авторскиe комментарии - это плохо #1

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Nov 12, 2016

дополнительно добавил подсветку

дополнительно добавил подсветку
Copy link

@nixel2007 nixel2007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

И трехстороннее сравнение через например kdiff3

@skyksandr
Copy link
Owner

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

@ghost
Copy link
Author

ghost commented Nov 12, 2016

@skyksandr тут такое дело - я специально это добавил, потому что это плохо, @kuntashov я думаю также будет ЗА.

@skyksandr
Copy link
Owner

@allustin Из того что смог найти на эту тему:
http://stackoverflow.com/questions/720082/should-you-comment-changes-in-code-and-in-the-changelog
http://stackoverflow.com/questions/3929241/vs2010-automatically-insert-date-and-initials-to-single-line-comments

Но я не нашел никакого объяснения почему это плохо.

@skyksandr
Copy link
Owner

К примеру - сходу не смог найти решение как найти все изменения выполненные конкретным человеком?
Grep и глобальный поиск решают такой вопрос на конфигурации размером с ERP 2 и УХ.
Есть другие способы?

@kuntashov
Copy link

@allustin эти авторские комментарии теперь как клеймо на моем лбу )

@skyksandr прав в том, что это повсеместно и пока прозрачной удобной работы с "правильными" системами контроля версий нет, то комментарии типа "такого-то числа здесь наговнокодил Вася" никуда не денутся )

Но именно по этой причине, я считаю, эти рекомендации надо как минимум игнорировать (т.е. в стайлгайдах ни про какие авторские комментарии не писать).

@skyksandr
Copy link
Owner

@kuntashov Согласен, по этой причине в стайлгайде нет раздела про то, что если вы меняете типовой код - то закомментируйте старый, добавьте вокруг изменения комментарий, содержащий сведения о том, кто, когда и почему и т.д.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants