Комментарии в .gitignore?

564

Вы можете написать комментарии в .gitignoreфайле?

Если это так, должна ли строка предшествовать с #или другим индикатором?

git comments gitignore

Если вы используете редактор, который знает об этих вещах (например, Vim), закомментированные строки #будут соответствующим образом отформатированы - так легко обнаружить себя таким образом!

— Каскабель

Так вы ищете .gitignoreignore?

— daviewales

Ответы:

700

Да, вы можете оставлять комментарии там. Однако они должны начинаться в начале строки.

ср http://git-scm.com/book/en/Git-Basics-Recording-Changes-to-the-Repository#Ignoring-Files

Правила для шаблонов, которые вы можете поместить в файл .gitignore, следующие:
- Пустые строки или строки, начинающиеся с #, игнорируются.
[...]

Символ комментария #, например:

# no .a files
*.a

— TimWolla
источник

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

— Стюарт Р. Джефферис

@ StuartR.Jefferys Я на git 1.7.4.1 и обнаруживаю, что строка с комментарием в конце не работает: src/main/log/ # Doesn't work. git status still shows this directory src/main/log/работает нормально. git status не показывает каталог. Фактически, кажется, что любые пробелы в конце строки считаются частью шаблона игнорирования.

— Иоганн

@Johann Ты прав! Конечный пробел является значительным, даже с каталогами (оканчивающимися на /). Если файл имеет завершающий пробел, .gitignoreзапись должна совпадать; 0 или 2 пробела, и это не удается. Я считаю это ошибкой. Я использую GIT версии 1.7.5.4. Это может быть преднамеренным, даже если это не должно быть . Но вы можете использовать [ ]как спецификатор пробела. Это намного лучше, чем допускать отставание пробела; он учитывает редкое преднамеренное конечное пространство, в то же время обнаруживая более распространенный (и трудно видимый) случай ошибки.

— Стюарт Р. Джефферис

Спасибо за это; Мне было труднее всего понять, почему gitигнорировал мой .gitignore. Это было потому, что я поместил комментарии в конце строки после некоторых записей. Цветовая подсветка синтаксиса VIM для configтипов файлов ввела меня в заблуждение.

— Люк Дэвис

209

Делать git help gitignore

Вы получите страницу справки со следующей строкой:

A line starting with # serves as a comment.

— manojlds
источник

+1 за указание, как найти информацию, а не просто дать информацию.

— Иван Бишевац

@ gregox - Also, I like using computers without command lines- тогда мерзавец не подходит для тебя, извини.

— Manojlds

@manojlds git- подходящее место для всех, как и все rsync. им просто нужны хорошие графические интерфейсы, такие как Dropbox.

— Жаль, что

Я предпочитаю CLI, но некоторые коллеги используют gitbox с переменным успехом. Думаю, есть и Git Tree, верно? @cregox

— Стивен Тетро

Вы также можете сделать git help ignore(что поддерживается git bash-завершением)

— user202729