Автоматически удалять комментарии из системы контроля версий или хранить комментарии кода в отдельных физических файлах

Question

Можно ли автоматически удалять комментарии кода в файлах Visual Studio перед передачей в систему управления исходным кодом, или можно фактически иметь комментарии в файлах, но физически сохранять их в отдельных файлах?

Конечной целью не являетсяиметь комментарии в системе контроля версий, но иметь их локально.

Answer 1

Это неправильно.

То, что вы должны удалить, это закомментированный код. Пусть система контроля версий сделает свое дело. Комментарии, которые иллюстрируют, что в коде и почему должны остаться.

Как вы ожидаете сохранить их, если вы удалите их в системе контроля версий? В следующий раз, когда вы проверите код, комментариев там не будет.

Answer 2

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

Благодаря комментариям другие разработчики могут выяснить, что происходит гораздо быстрееи быть более точным, а также.Они могут находить ошибки и улучшать ваш код.Итак, комментарии классные.Я имею в виду, хорошие комментарии.Я знаю, что код должен говорить сам по себе, но комментарии также важны.

Если вы собираетесь экономить память, не делайте этого для процесса разработки.Что вы можете сделать, это развернуть свой код без каких-либо комментариев и, если возможно, сжать.

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