gitcommentsgitignore

How to add a comment in a .gitignore file?

Can you write comments in a .gitignore file?

If so, should the line be preceded with a # or some other indicator?

Solution

  • Yes, you may put comments in there. They however must start at the beginning of a line.

    cf. https://git-scm.com/book/id/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring

    The rules for the patterns you can put in the .gitignore file are as follows:

    The comment character is #, example:

    # no .a files
*.a