.gitignore 用于 Visual Studio 项目和解决方案

Question

将Git与Visual Studio解决方案 ( .sln ) 和项目结合使用时，我应该在.gitignore中包含哪些文件？

Answer 1

参见官方 GitHub 的“有用的.gitignore模板合集” 。

Visual Studio 的.gitignore可以在这里找到：
https://github.com/github/gitignore/blob/main/VisualStudio.gitignore

Answer 2

有一个在线工具可以让你根据你的操作系统、IDE、语言等生成 .gitignore 文件。看看http://www.gitignore.io/ 。

2014 年 8 月 20 日，这是为 Visual Studio + Windows 生成的文件。

# Created by http://www.gitignore.io

### VisualStudio ###
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.sln.docstates

# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
build/
bld/
[Bb]in/
[Oo]bj/

# Roslyn cache directories
*.ide/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

#NUNIT
*.VisualState.xml
TestResult.xml

# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c

*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc

# Chutzpah Test files
_Chutzpah*

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf
*.cachefile

# Visual Studio profiler
*.psess
*.vsp
*.vspx

# TFS 2012 Local Workspace
$tf/

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user

# JustCode is a .NET coding addin-in
.JustCode

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# NCrunch
_NCrunch_*
.*crunch*.local.xml

# MightyMoose
*.mm.*
AutoTest.Net/

# Web workbench (sass)
.sass-cache/

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# TODO: Comment the next line if you want to checkin your web deploy settings 
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj

# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/packages/*
# except build/, which is used as an MSBuild target.
!**/packages/build/
# If using the old MSBuild-Integrated Package Restore, uncomment this:
#!**/packages/repositories.config

# Windows Azure Build Output
csx/
*.build.csdef

# Windows Store app package directory
AppPackages/

# Others
sql/
*.Cache
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.pfx
*.publishsettings
node_modules/

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm

# SQL Server files
*.mdf
*.ldf

# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings

# Microsoft Fakes
FakesAssemblies/


### Windows ###
# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Windows Installer files
*.cab
*.msi
*.msm
*.msp

Answer 3

我将以下 .gitignore 用于 C# 项目。 在需要时添加其他模式。

[Oo]bj
[Bb]in
*.user
*.suo
*.[Cc]ache
*.bak
*.ncb
*.log 
*.DS_Store
[Tt]humbs.db 
_ReSharper.*
*.resharper
Ankh.NoLoad

Answer 4

对于那些对微软认为应该包含在 gitignore 中的内容感兴趣的人，这里是Visual Studio 2013 RTM在创建新 Git-Repository 时自动生成的默认值：

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.sln.docstates

# Build results

[Dd]ebug/
[Rr]elease/
x64/
build/
[Bb]in/
[Oo]bj/

# Enable "build/" folder in the NuGet Packages folder since NuGet packages use it for MSBuild targets
!packages/*/build/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

*_i.c
*_p.c
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.log
*.scc

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opensdf
*.sdf
*.cachefile

# Visual Studio profiler
*.psess
*.vsp
*.vspx

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# NCrunch
*.ncrunch*
.*crunch*.local.xml

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.Publish.xml

# NuGet Packages Directory
## TODO: If you have NuGet Package Restore enabled, uncomment the next line
#packages/

# Windows Azure Build Output
csx
*.build.csdef

# Windows Store app package directory
AppPackages/

# Others
sql/
*.Cache
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.[Pp]ublish.xml
*.pfx
*.publishsettings

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file to a newer
# Visual Studio version. Backup files are not needed, because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm

# SQL Server files
App_Data/*.mdf
App_Data/*.ldf


#LightSwitch generated files
GeneratedArtifacts/
_Pvt_Extensions/
ModelManifest.xml

# =========================
# Windows detritus
# =========================

# Windows image file caches
Thumbs.db
ehthumbs.db

# Folder config file
Desktop.ini

# Recycle Bin used on file shares
$RECYCLE.BIN/

# Mac desktop service store files
.DS_Store

请参阅： 在 MSDN 上添加默认 .gitignore 文件

Answer 5

虽然您应该保留 NuGet packages.config 文件，但您应该排除 packages 文件夹：

#NuGet
packages/

我通常不会在源代码控制中存储二进制文件或从我的源代码生成的任何内容。 不过，对此有不同意见。 如果它使您的构建系统变得更容易，那就去做吧！ 但是，我认为您没有对这些依赖项进行版本控制，因此它们只会占用您存储库中的空间。 在我看来，将二进制文件存储在一个中央位置，然后依靠 packages.config 文件来指示需要哪个版本是一个更好的解决方案。

Answer 6

我知道这是一个老问题，仍在分享信息。 在 Visual Studio 2017 中，您只需右键单击解决方案文件并选择将解决方案添加到源代码管理

这会将两个文件添加到您的源文件夹中。

1. .git 属性
2. .gitignore

这是最简单的方法。

Answer 7

我更喜欢根据需要排除事物。 您不希望shotgun 排除名称中带有字符串“bin”或“obj”的所有内容。 至少一定要跟随那些带有斜线的人。

这是我从 VS2010 项目开始的内容：

bin/
obj/
*.suo
*.user

只是因为我使用了 ReSharper，这也是：

_ReSharper*

Answer 8

在 Visual Studio 2015 Update 3 上，并且从今天 (2016-10-24) 开始更新 Git 扩展，Visual Studio 生成的.gitignore是：

## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.

# User-specific files
*.suo
*.user
*.userosscache
*.sln.docstates

# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs

# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
[Xx]64/
[Xx]86/
[Bb]uild/
bld/
[Bb]in/
[Oo]bj/

# Visual Studio 2015 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/

# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*

# NUNIT
*.VisualState.xml
TestResult.xml

# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c

# DNX
project.lock.json
artifacts/

*_i.c
*_p.c
*_i.h
*.ilk
*.meta
*.obj
*.pch
*.pdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc

# Chutzpah Test files
_Chutzpah*

# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db

# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap

# TFS 2012 Local Workspace
$tf/

# Guidance Automation Toolkit
*.gpState

# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user

# JustCode is a .NET coding add-in
.JustCode

# TeamCity is a build add-in
_TeamCity*

# DotCover is a Code Coverage Tool
*.dotCover

# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*

# MightyMoose
*.mm.*
AutoTest.Net/

# Web workbench (sass)
.sass-cache/

# Installshield output folder
[Ee]xpress/

# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html

# Click-Once directory
publish/

# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml

# TODO: Un-comment the next line if you do not want to checkin 
# your web deploy settings because they may include unencrypted
# passwords
#*.pubxml
*.publishproj

# NuGet Packages
*.nupkg
# The packages folder can be ignored because of Package Restore
**/packages/*
# except build/, which is used as an MSBuild target.
!**/packages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/packages/repositories.config
# NuGet v3's project.json files produces more ignoreable files
*.nuget.props
*.nuget.targets

# Microsoft Azure Build Output
csx/
*.build.csdef

# Microsoft Azure Emulator
ecf/
rcf/

# Microsoft Azure ApplicationInsights config file
ApplicationInsights.config

# Windows Store app package directory
AppPackages/
BundleArtifacts/

# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!*.[Cc]ache/

# Others
ClientBin/
[Ss]tyle[Cc]op.*
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.pfx
*.publishsettings
node_modules/
orleans.codegen.cs

# RIA/Silverlight projects
Generated_Code/

# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm

# SQL Server files
*.mdf
*.ldf

# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings

# Microsoft Fakes
FakesAssemblies/

# GhostDoc plugin setting file
*.GhostDoc.xml

# Node.js Tools for Visual Studio
.ntvs_analysis.dat

# Visual Studio 6 build log
*.plg

# Visual Studio 6 workspace options file
*.opt

# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions

# LightSwitch generated files
GeneratedArtifacts/
ModelManifest.xml

# Paket dependency manager
.paket/paket.exe

# FAKE - F# Make
.fake/

Answer 9

在 Visual Studio 2015 团队资源管理器 > 本地 Git 存储库 > 项目 > 设置 > Git > 存储库设置 > 忽略和属性文件中。您可以添加 .gitignore 文件，其中默认情况下在 Visual Studio 解决方案中应忽略项目。

Answer 10

使用 Visual Studio 添加 .gitignore

打开 Visual Studio 和需要忽略文件的解决方案。 从顶部菜单中选择Git > 设置。

以上将打开 Visual Studio 的选项，并选择 Source Control > Git Global Settings。 从左侧的列表中选择Git Repository Settings ，然后单击Ignore file的Add按钮。

以上将添加（和提交阶段）一个 .gitignore 文件，其中忽略了典型 Visual Studio 设置的所有正确文件。

https://elanderson.net/2020/10/add-git-ignore-to-an-existing-visual-studio-solution-new-git-experience/

请注意，如果您的 repo 根目录中已经有一个 .gitignore 文件，“添加”按钮将改为显示“编辑”，按下该按钮只会打开文件而不更新它，这不是很有帮助。 在这种情况下，您可以首先重命名 .gitignore 文件，单击添加按钮，取消暂存新的 .gitignore 文件，然后根据需要合并保存的副本更改。

Answer 11

我知道这是一个旧线程，但是对于访问此页面的新老用户，有一个名为gitignore.io的网站可以生成这些文件。 登陆网站后搜索“visualstudio”，它将为您生成这些文件，您也可以将多种语言/ide忽略文件连接到一个文档中。

美丽的。

Answer 12

为构建部署添加了 InstallShield 忽略。 InstallShield 是 Microsoft 在 Visual Studio Installer 上的新方向，因此我们已经开始在所有新项目中使用它。 添加的这一行将删除 SingleImage 安装文件。 其他 InstallShield 类型可能包括 DVD 分发等。 您可能想要添加这些目录名称或只是 [Ee]xpress/ 以防止任何 InstallShield LE 部署文件进入存储库。

这是我们为 VS2010 C# 项目使用 Install Shield LE 和 SingleImage 部署的安装程序的 .gitignore：

#OS junk files
[Tt]humbs.db
*.DS_Store

#Visual Studio files
*.[Oo]bj
*.exe
*.pdb
*.user
*.aps
*.pch
*.vspscc
*.vssscc
*_i.c
*_p.c
*.ncb
*.suo
*.tlb
*.tlh
*.bak
*.[Cc]ache
*.ilk
*.log
*.lib
*.sbr
*.sdf
ipch/
obj/
[Bb]in
[Dd]ebug*/
[Rr]elease*/
Ankh.NoLoad

#InstallShield
[Ss]ingle[Ii]mage/
[Dd][Vv][Dd]-5/
[Ii]nterm/

#Tooling
_ReSharper*/
*.resharper
[Tt]est[Rr]esult*

#Project files
[Bb]uild/

#Subversion files
.svn

# Office Temp Files
~$*

Answer 13

在这里聚会迟到了，但我也发现我使用了以下内容。 有些可能仅对在推送到公共遥控器时隐藏敏感文件有用。

#Ignore email files delivered to specified pickup directory
*.eml

#Allow NuGet.exe (do not ignore)
!NuGet.exe

#Ignore WebDeploy publish profiles
*.Publish.xml

#Ignore Azure build csdef & Pubxml files
ServiceDefinition.build.csdef
*.azurePubxml

#Allow ReSharper .DotSettings (for non-namespace-provider properties)
!*.csproj.DotSettings

#Ignore private folder
/Private/

Answer 14

这是我最近从事的一个项目的.gitignore的摘录。 我提取了我认为与 Visual Studio 相关的那些，包括编译输出； 这是一个跨平台项目，因此对于其他构建系统生成的文件还有各种其他忽略规则，我不能保证我将它们完全分开。

*.dll
*.exe
*.exp
*.ilk
*.lib
*.ncb
*.log
*.pdb
*.vcproj.*.user
[Dd]ebug
[Rr]elease

也许这个问题应该是 Community Wiki，所以我们可以一起编辑一个主列表，其中包含关于哪些文件应该被哪些类型的项目忽略的评论？

Answer 15

这要归功于 Jens Lehmann - 如果您将源目录与编译器项目文件分开并构建输出，则可以通过否定它来简化 .gitignore：

path/to/build/directory/*
!*.sln
!*.vcproj

你没有说你正在使用什么语言，但上面应该适用于 C++ 项目。

Answer 16

您可以通过转到团队资源管理器中的设置视图，然后选择存储库设置来为您的存储库创建或编辑 .gitignore 文件。 为您的 .gitignore 选择编辑。

它会自动创建过滤器，这些过滤器将忽略所有 VS 特定的构建目录等。

更多信息请看这里。

Answer 17

如果您在解决方案中使用 dbproj，您将需要添加以下内容：

#Visual Studio DB Project
*.dbmdl
[Ss]ql/

来源：http: //blogs.msdn.com/b/bahill/archive/2009/07/31/come-visit-revisit-the-beer-house-continuous-integration.aspx

Answer 18

Visual Studio 中有一个快捷方式，因为它在 2015 年或更高版本中支持开箱即用的 Git。 对于新解决方案（或一些没有.git文件夹的解决方案），请使用解决方案资源管理器中的源代码管理功能：

右键单击您的解决方案并在弹出菜单中选择Add Solution to Source Control...项目。

它会自动初始化.git存储库，将.gitignore和必要的东西添加到您的解决方案中，甚至是.gitattributes文件（行尾等）。

文本将出现在 VS 控制台中：

A new Git repository has been created for you in C:\<path to your solution>
Commit ______ created locally in repository.

完毕！

Answer 19

正如另一张海报所提到的，Visual Studio 将其作为其 .gitignore 的一部分生成（至少对于 MVC 4）：

# SQL Server files
App_Data/*.mdf
App_Data/*.ldf

由于您的项目可能是解决方案的子文件夹，并且 .gitignore 文件存储在解决方案根目录中，因此这实际上不会触及本地数据库文件（Git 在projectfolder/App_Data/*.mdf看到它们）。 为了解决这个问题，我改变了这些行，如下所示：

# SQL Server files
*App_Data/*.mdf
*App_Data/*.ldf

Answer 20

这是我在 .NET 项目中用于.gitignore文件的内容。

[Oo]bj/
[Bb]in/
*.suo
*.user
/TestResults
*.vspscc
*.vssscc

这几乎是一种全 MS 方法，它使用内置的 Visual Studio 测试器，以及一个可能包含一些 TFS 绑定的项目。

Answer 21

它应该取决于您使用的项目或语言。 因此，与构建、vs 文件夹、sln 文件、bin 文件夹等相关的扩展将被包括在内。 有关 git 忽略文件的完整列表，您可以查看此 repo gitignore for visual studio

Answer 22

某些项目可能希望将*.manifest添加到他们的Visual Studio gitignore.io文件中。

这是因为新项目的一些Visual Studio 项目属性设置为生成清单文件。

请参阅“ Visual Studio 中的清单生成”

但是，如果您已生成它们并且它们是静态的（不会随时间变化），那么最好将它们从.gitignore文件中删除。

这就是像Git for Windows这样的项目刚刚所做的（​​对于 Git 2.24，2019 年第四季度）

请参阅Johannes Schindelin ( dscho )的提交 aac6ff7 （2019 年 9 月 5 日）。
^{（由Junio C Hamano -- gitster --在提交 59438be中合并，2019 年 9 月 30 日）}

.gitignore : 停止忽略.manifest文件

在 Windows 上，可以通过链接“清单”（即描述功能和要求（例如最小或最大 Windows 版本）的 XML 文档）将附加元数据嵌入到可执行文件中。
这些 XML 文档应存储在.manifest文件中。

至少有一些Visual Studio 版本在没有明确指定时会自动生成.manifest文件，因此我们曾经要求 Git 忽略它们。

但是，我们现在确实有一个漂亮的.manifest文件： compat/win32/git.manifest ，所以 Visual Studio 也不会为我们自动生成清单，我们也不希望 Git 再忽略.manifest文件。