.gitignore for Visual Studio项目和解决方案

Question

将Git与Visual Studio Solutions（.gitignore）和项目结合使用时，我应该在.sln中包含哪些文件？

Answer 1

请参阅官方GitHub的"Collection of useful .gitignore templates"。

Visual Studio的.gitignore可以在这里找到：
https://github.com/github/gitignore/blob/master/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

我在C＃项目中使用以下.gitignore。在需要时添加其他模式。

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

Answer 4

对于那些对 Microsoft 认为应该包含在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

请参阅：Add a default .gitignore file on MSDN

Answer 5

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

#NuGet
packages/

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

Answer 6

我更喜欢根据需要排除事物。你不想用霰弹枪排除所有字符串＆＃34; bin＆＃34;或＆＃34; obj＆＃34;在名字里。 至少一定要遵循斜线。

这是我在VS2010项目中的开始：

bin/
obj/
*.suo
*.user

只是因为我使用ReSharper，还有这个：

_ReSharper*

Answer 7

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

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

以下是使用Install Shield LE和安装程序的SingleImage部署的VS2010 C＃项目的.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 9

以下是我正在处理的最近项目中.gitignore的摘录。我已经提取了我认为与Visual Studio相关的内容，包括编译输出;它是一个跨平台项目，因此其他构建系统生成的文件还有其他各种忽略规则，我无法保证将它们完全分开。

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

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

Answer 10

在Visual Studio 2015团队资源管理器中＆gt;本地Git存储库＆gt;项目＆gt;设置＆gt; Git＆gt;存储库设置＆gt;忽略＆amp;属性文件。默认情况下，您可以在visual studio解决方案中添加带有项目的.gitignore文件。

Answer 11

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

美丽。

Answer 12

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

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

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

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

您没有说明您使用的语言，但上述内容适用于C ++项目。

Answer 14

如果您在解决方案中使用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 15

Visual Studio中有一个快捷方式，因为它在2015年或更高版本中支持开箱即用的Git。对于新解决方案（或某些没有# set user agent user_agent = ("Mozilla/5.0 (iPhone; CPU iPhone OS 8_0 like Mac OS X) AppleWebKit/600.1.3 (KHTML, like Gecko) Version/8.0 Mobile/12A4345d Safari/600.1.4") # user_agent = ("Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_2 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11A4449d Safari/9537.53") # user_agent = ("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36") dcap = dict(DesiredCapabilities.PHANTOMJS) dcap["phantomjs.page.settings.userAgent"] = user_agent dcap["phantomjs.page.settings.javascriptEnabled"] = True dcap["phantomjs.page.settings.loadImages"] = True # dcap["phantomjs.page.settings.viewportSize"] = { # "width" : 640 # , "height" : 640 # } browser = webdriver.PhantomJS(service_log_path=os.path.devnull, executable_path="/var/task/phantomjs", service_args=['--ignore-ssl-errors=true'], desired_capabilities=dcap) browser.set_window_size(640,640) browser.implicitly_wait(5) #seconds browser.get(['url']) # Capture the screenshot screenshot = browser.get_screenshot_as_png() # Close the browser browser.close() 文件夹），请使用解决方案资源管理器中的源代码管理功能：

在解决方案上单击鼠标右键，然后在弹出菜单中选择.git项。

它会自动初始化Add Solution to Source Control...存储库，为解决方案添加.git必要的内容，甚至.gitignore文件（行结尾等）。

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

.gitattributes

完成！

Answer 16

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

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

1. .gitattributes
2. .gitignore

这是最简单的方法。

Answer 17

使用 Visual Studio 添加 .gitignore

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

以上将打开 Visual Studio 的选项，并选择 Source Control > Git Global Settings。从左侧的列表中选择Git 存储库设置，然后为忽略文件点击添加按钮。

上面的代码将添加一个 .gitignore 文件，其中忽略了典型 Visual Studio 设置的所有正确文件。

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

Answer 18

正如另一张海报所提到的，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 19

我的.gitignore文件的what I use in my .NET Projects。

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

这几乎是一种全MS方法，它使用内置的Visual Studio测试程序，以及可能在其中有一些TFS绑定的项目。

Answer 20

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

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

更多信息请看here。

Answer 21

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

Answer 22

某些项目可能希望将*.manifest添加到他们的visual studio gitignore.io file。

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

请参见“ Manifest Generation in Visual Studio”

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

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

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

  

.gitignore：停止忽略.manifest个文件

     

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

     

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

     

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