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


1144

.gitignoreGitVisual Studio解决方案(.sln)和Projects 一起使用时,我应包括哪些文件?



1
我将其制作为社区Wiki,并将所有现有答案合并到了帖子中。请按您认为合适的方式做出贡献!
Martin Suchanek 2010年

12
我会小心地忽略.exe和.pdb,您可能会无意中忽略与源一起存储的工具(nant,nunit gui等)。
詹姆斯·格雷戈里

2
@murki-答案似乎是这样:coderjournal.com/2011/12/…–
Ronnie Overby,

7
随着.sln文件的签入,我们得到的噪声DIFFS如 -# Visual Studio 14 -VisualStudioVersion = 14.0.24720.0 +# Visual Studio 2013 +VisualStudioVersion = 12.0.31101.0 能这样可以避免?
让·乔丹

Answers:


592

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

.gitignore为Visual Studio可以在这里找到:
https://github.com/github/gitignore/blob/master/VisualStudio.gitignore


8
请注意。该文件包含一个忽略发布文件的条目。无论规则的编写方式如何,它都会忽略您称为“发布”的任何文件夹,并且将忽略该文件夹下的所有内容。它没有专门针对Visual Studio“发布”输出。它会忽略它,但也会忽略其他东西。
Rex Whitten 2014年

6
@starfighterxyz如果您认为gitignore中存在错误,建议您创建一个pull请求。
2014年

9
好吧,我不知道(足够吗?)说它是一个错误。我只是碰巧正在使用Publish /作为控制器名称,以及作为项目文件夹名称。我认为这只是一个极端情况。只是可以节省您几个小时的时间
而已

2
@Learner,因为它们位于不同的文件中。您应该将这些添加到您的个人全局gitignore中,而不是将其检入。github.com
github/gitignore/

1
@ErikAronesty,您可以在github存储库上创建问题或PR。但是*.user已经被忽略了,其中包括.vcxproj.user
慢性

254

有一个在线工具,可让您根据操作系统,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

理想情况下,它将在文件内包含一个许可证。(理想情况下,这将是一个在公司环境中不会引起任何疑问的许可证。)
Evgeni Sergeev

此外,它应该具有.vs/,请参见此处:stackoverflow.com/a/31879242/1143274
Evgeni Sergeev

110

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

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

2
不同意*.resharper。文件匹配*.ReSharper.user应该被忽略,但是*.user上面的规则满足了这一要求。
德鲁·诺阿克斯

1
@DrewNoakes:您认为应该对ReSharper文件进行修订控制吗?
Per Lundberg 2013年

4
@PerLundberg值得考虑的原因之一是您可以配置标准项目格式设置选项等,并将配置文件保存在项目中。如果在git中,则使用Resharper的每个人都可以更轻松地保持项目的一致格式。
2015年

@DrewNoakes- 对此有什么建议吗?
xameeramir 2015年

44

对于那些对Microsoft认为应包含在gitignore中的内容感兴趣的人,以下是Visual Studio 2013 RTM在创建新的Git存储库时自动生成的默认值:

## 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文件


37

在保留NuGetpackages.config文件的同时,应排除packages文件夹:

#NuGet
packages/

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


4
有谁愿意详细说明为什么要排除“包”文件夹?为构建服务器包含依赖项的软件包不是很有意义吗?
乔尔·马丁内斯

14
值得注意的是,NuGet团队针对此问题实施了“程序包还原”功能。NuGet网站上有一个文档,解释了该功能并描述了如何在Visual Studio中使用它。
2012年

4
如果您忽略软件包并使用nuget软件包还原,则允许nuget.exe会很有帮助。当有人下载​​时,这可以帮助VS告诉该解决方案已启用该功能:!NuGet.exe<-不要忽略此文件。
danludwig 2012年

对于那些使用AppHarbor的用户来说,值得注意的是,排除packages文件夹将导致您的构建无法部署:)
Joel Martinez

18

我宁愿根据需要排除事物。您不想散弹枪排除名称中带有字符串“ bin”或“ obj”的所有内容。至少一定要跟那些斜线。

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

bin/
obj/
*.suo
*.user

而且因为我使用了ReSharper,这也是:

_ReSharper*

同意。同样,这也适用于“调试”。为此添加斜杠以避免在名称中使用debug忽略文件。
John Korsnes 2014年

16

我了解这是一个古老的问题,仍在共享信息。在Visual Studio 2017中,您可以右键单击解决方案文件并选择将解决方案添加到源代码管理

在此处输入图片说明

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

  1. .gitattributes
  2. .gitignore

这是最简单的方法。


11

在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/

3
我喜欢这部分:Backup & report files from converting an old project file to a newer Visual Studio version. Backup files are not needed, because we have git ;-)
Jeancarlo Fontalvo

10

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

在此处输入图片说明


9

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

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

#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
~$*

1
我在这里引用James Gregory的评论:“我会小心地忽略.exe和.pdb,您可能会无意中忽略与源一起存储的工具(nant,nunit gui等...)。– James Gregory 2010年5月21日于13:32“
Jim Raden

1
不同意*.resharper。文件匹配*.ReSharper.user应该被忽略,但是*.user上面的规则满足了这一要求。
德鲁·诺阿克斯

只是澄清一下-实际上是将其移回到Visual Studio安装程序之前存在的InstallShield,至少可以追溯到1998年!
Mathieson

7

我知道这是一个旧主题,但是对于访问此页面的新老朋友,都有一个名为gitignore.io的网站可以生成这些文件。在登陆网站后搜索“ visualstudio”,它将为您生成这些文件,您也可以将多种语言/想法忽略并置在一个文档中的文件。

美丽。


6

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

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

也许这个问题应该是Community Wiki,所以我们所有人都可以一起编辑一个主列表,并附上关于哪些项目类型应忽略哪些文件的注释。


请参阅James Gregory对另一个答案的评论:“我会小心地忽略.exe和.pdb,您可能会无意中忽略与源一起存储的工具(nant,nunit gui等...)。– James Gregory,2010年5月21日13:32“
Jim Raden 2012年

2
@JimRaden通常,最好避免将二进制工具签入Git。最佳做法是仅将源签入Git;如果您需要二进制工具,请包括用于安装它们的脚本或仅包含那些工具的子模块。
布莱恩·坎贝尔

6

值得一提的是Jens Lehmann-如果将源目录与编译器项目文件分离开来并构建输出,则可以通过对其进行取反来简化.gitignore:

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

您没有说使用什么语言,但是以上内容适用于C ++项目。


我不知道.gitignore中有否定标志。有用的提示!
Jim Raden 2012年

6

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

#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/

最新版本不需要显式忽略nuget.exe
tofutim 2012年

@tofutim,最新版本是什么?git本身?
danludwig 2012年


4

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.

做完了!



3

如另一位发布者所述,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

1
实际上,除非您以“ /” 开头,否则git也会匹配相对于子目录的模式,在这种情况下,它们仅与.gitignore文件所在目录中的内容匹配。
SamB 2015年

0

某些项目可能想要添加*.manifest到其Visual Studio gitignore.io文件中

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

请参见“ Visual Studio中的清单生成

但是,如果生成了它们并且它们是静态的(不会随时间变化),那么最好将它们从.gitignore文件中删除。

这就是像Windows的Git这样的项目所做的(对于Git 2.24,Q4 2019)

请参阅Johannes Schindelin()的commit aac6ff7(2019年9月5日(由Junio C Hamano合并--commit 59438be中,2019年9月30日)dscho
gitster

.gitignore:停止忽略.manifest文件

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

至少某些 Visual Studio版本会自动生成.manifest当没有明确指定文件时,文件,因此我们通常要求Git忽略它们。

但是,我们现在确实有一个漂亮的.manifest文件:compat/win32/git.manifest,因此Visual Studio既不会为我们自动生成清单,也不想让Git .manifest不再忽略这些文件。


0

通过转到Team Explorer中的“设置”视图,然后选择“存储库设置”,可以为您的存储库创建或编辑.gitignore文件。选择.gitignore的编辑。

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

在此处输入图片说明

更多信息请看这里

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.