Comentários em .gitignore?

564

Você pode escrever comentários em um .gitignorearquivo?

Em caso afirmativo, a linha deve ser precedida por um #ou outro indicador?

git comments gitignore

— James Raitsev
fonte

Se você usar um editor que saiba sobre essas coisas (por exemplo, Vim), as linhas comentadas #serão formatadas adequadamente - fácil de se descobrir dessa maneira!

— Cascabel

Então você está procurando um .gitignoreignore?

— daviewales 26/02

Respostas:

699

Sim, você pode colocar comentários lá. No entanto, eles devem começar no início de uma linha.

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

As regras para os padrões que você pode colocar no arquivo .gitignore são as seguintes:
- Linhas em branco ou linhas começando com # são ignoradas.
[...]

O caractere de comentário é #, exemplo:

# no .a files
*.a

— TimWolla
fonte

Não sei se isso foi verdade quando isso foi respondido, mas a seção do livro vinculado indica que, além de iniciar uma linha, os comentários também podem ser anexados a uma linha no arquivo .gitignore.

— Stuart R. Jefferys

@ StuartR.Jefferys Estou no git 1.7.4.1 e estou descobrindo que uma linha com um comentário no final não funciona: src/main/log/ # Doesn't work. git status still shows this directory src/main/log/funciona bem. O status git não mostra o diretório De fato, parece que qualquer espaço em branco no final da linha é considerado parte do padrão de ignorar.

— Johann

@Johann Você está certo! O espaço em branco à direita é significativo, mesmo com diretórios (terminando em /). Se um arquivo tiver um espaço à direita, a .gitignoreentrada deverá corresponder; 0 ou 2 espaços e falha. Eu considero um bug. Estou usando a versão 1.7.5.4 do git. Ele poderia ser intencional, mesmo que provavelmente não deveria . Mas você pode usar [ ]como um especificador de caracteres de espaço. Isso é muito melhor do que permitir espaço em branco à direita; ele permite o raro espaço intencional à direita, enquanto detecta o caso de erro mais comum (e difícil de ver).

— Stuart R. Jefferys

Obrigado por isso; Eu estava tendo mais dificuldade tentando entender por que gitestava ignorando o meu .gitignore. Foi porque eu coloquei comentários de fim de linha depois de algumas entradas. A cor da sintaxe padrão do VIM para configtipos de arquivos me enganou.

— Luke Davis

208

Faz git help gitignore

Você receberá a página de ajuda com a seguinte linha:

A line starting with # serves as a comment.

— manojlds
fonte

+1 para indicar como encontrar informações, não apenas fornecendo informações.

— 22414 #

@cregox - Also, I like using computers without command lines- git é o lugar errado para você, desculpe.

— Manojlds

@manojlds gité o lugar certo para todos, assim como rsync. eles só precisam de boas GUIs, como o Dropbox. muito triste que ainda está faltando uma para git ...

— cregox

Eu prefiro a CLI, mas alguns colegas de trabalho usam o gitbox com sucesso variável. Há também o Git Tree, eu acho, certo? @cregox

— Stephen Tetreault

Você também pode fazer git help ignore(que é suportado pelo git bash-conclusão) #

— user202729 21/21/19