github/gitignore · VisualStudio.gitignore
Visual Studio .gitignore 模板详解
说明 VisualStudio.gitignore 忽略 .vs 目录、用户专属设置、Debug/Release 构建结果、NuGet 包、测试结果和发布配置文件的原因。
VisualStudio.gitignore 是模板仓库中最长的文件之一,面向使用 Visual Studio 开发的 C#、VB、C++、ASP.NET 项目。它广泛覆盖 IDE 生成的用户专属文件、按构建配置区分的输出目录、NuGet、测试与覆盖率工具,以及 ReSharper 等扩展的缓存。
考虑到大小写混用的 Windows 环境,它的特点是大量使用 [Dd]ebug/ 这样用方括号同时匹配大小写的模式。git 默认区分大小写,因此需要这种写法。
逐条规则详解
| 模式 | 忽略什么,为什么忽略 |
|---|---|
*.rsuser*.suo*.user*.userosscache*.sln.docstates.vs/ | 用户专属文件打开的窗口、断点、启动项目等个人 IDE 状态。.vs/ 目录中还包含 IntelliSense 数据库之类的大型缓存。 |
[Dd]ebug/[Rr]elease/[Rr]eleases/bin/x64/obj/x86/[Oo]bj/**/[Bb]in/*bld/ | 按构建配置区分的输出按配置(Debug/Release)和平台(x64/x86)生成的编译结果。**/[Bb]in/* 只排除 bin 目录中的内容,因此需要时可以用 ! 恢复特定文件。 |
[Tt]est[Rr]esult*/*.trxTestResult.xmlnunit-*.xml*.VisualState.xml | 测试结果MSTest、NUnit 留下的结果文件,每次运行都会重新写入。 |
*.nupkg*.snupkg**/[Pp]ackages/*!**/[Pp]ackages/build/*.nuget.props*.nuget.targets | NuGet可以通过包还原重新获取的文件。只把 packages 目录下的 build 子目录作为例外保留,以支持按旧方式放置构建脚本的情况。 |
publish/*.pubxml*.publishprojPublishScripts/*.azurePubxml | 发布与部署设置Web 部署的结果和发布配置文件。正如模板注释所说,发布配置文件中可能以未加密的形式包含数据库连接字符串。 |
*.pdb*.pch*.ilk*.tlog*.tmp*.logipch/*.VC.db | 生成与中间文件调试符号、预编译头、MSBuild 跟踪日志、C++ IntelliSense 数据库等构建过程的副产物。 |
_ReSharper*/*.DotSettings.user_NCrunch_**.dotCover.axoCover/*!.axoCover/settings.json | 扩展工具缓存ReSharper、NCrunch、dotCover、AxoCover 等扩展生成的缓存。只重新包含需要与团队共享的 AxoCover 配置文件。 |
实践中的注意事项
- 如果需要通过仓库共享发布配置文件,可以删除
*.pubxml这一行,但仍要排除包含密码的*.pubxml.user。 - 如果只处理新式 .NET SDK 项目,更短的 Dotnet 模板更易读。同时选择两个模板时,去重选项会整理重叠的规则。
*.env规则会忽略所有名称以.env结尾的文件,因此示例文件请使用sample.env.example这类不同的扩展名。
原始模板
VisualStudio.gitignore
## Ignore Visual Studio temporary files, build results, and## files generated by popular Visual Studio add-ons.#### Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore# User-specific files*.rsuser*.suo*.user*.userosscache*.sln.docstates*.env# User-specific files (MonoDevelop/Xamarin Studio)*.userprefs# Mono auto generated filesmono_crash.*# Build results[Dd]ebug/[Dd]ebugPublic/[Rr]elease/[Rr]eleases/[Dd]ebug/x64/[Dd]ebugPublic/x64/[Rr]elease/x64/[Rr]eleases/x64/bin/x64/obj/x64/[Dd]ebug/x86/[Dd]ebugPublic/x86/[Rr]elease/x86/[Rr]eleases/x86/bin/x86/obj/x86/[Ww][Ii][Nn]32/[Aa][Rr][Mm]/[Aa][Rr][Mm]64/[Aa][Rr][Mm]64[Ee][Cc]/bld/[Oo]bj/[Oo]ut/[Ll]og/[Ll]ogs/# Build results on 'Bin' directories**/[Bb]in/*# Uncomment if you have tasks that rely on *.refresh files to move binaries# (https://github.com/github/gitignore/pull/3736)#!**/[Bb]in/*.refresh# Visual Studio 2015/2017 cache/options directory.vs/# Uncomment if you have tasks that create the project's static files in wwwroot#wwwroot/# Visual Studio 2017 auto generated filesGenerated\ Files/# MSTest test Results[Tt]est[Rr]esult*/[Bb]uild[Ll]og.**.trx# NUnit*.VisualState.xmlTestResult.xmlnunit-*.xml# Approval Tests result files*.received.*# Build Results of an ATL Project[Dd]ebugPS/[Rr]eleasePS/dlldata.c# Benchmark ResultsBenchmarkDotNet.Artifacts/# .NET Coreproject.lock.jsonproject.fragment.lock.jsonartifacts/.artifacts/# ASP.NET ScaffoldingScaffoldingReadMe.txt# StyleCopStyleCopReport.xml# Files built by Visual Studio*_i.c*_p.c*_h.h*.ilk*.meta*.obj*.idb*.iobj*.pch*.pdb*.ipdb*.pgc*.pgd*.rsp# but not Directory.Build.rsp, as it configures directory-level build defaults!Directory.Build.rsp*.sbr*.tlb*.tli*.tlh*.tmp*.tmp_proj*_wpftmp.csproj*.log*.tlog*.vspscc*.vssscc.builds*.pidb*.svclog*.scc# Chutzpah Test files_Chutzpah*# Visual C++ cache filesipch/*.aps*.ncb*.opendb*.opensdf*.sdf*.cachefile*.VC.db*.VC.VC.opendb# Visual Studio profiler*.psess*.vsp*.vspx*.sap# Visual Studio Trace Files*.e2e# TFS 2012 Local Workspace$tf/# Guidance Automation Toolkit*.gpState# ReSharper is a .NET coding add-in_ReSharper*/*.[Rr]e[Ss]harper*.DotSettings.user# TeamCity is a build add-in_TeamCity*# DotCover is a Code Coverage Tool*.dotCover# AxoCover is a Code Coverage Tool.axoCover/*!.axoCover/settings.json# Coverlet is a free, cross platform Code Coverage Toolcoverage*.jsoncoverage*.xmlcoverage*.info# Visual Studio code coverage results*.coverage*.coveragexml# NCrunch_NCrunch_*.NCrunch_*.*crunch*.local.xmlnCrunchTemp_*# MightyMoose*.mm.*AutoTest.Net/# Web workbench (sass).sass-cache/# Installshield output folder[Ee]xpress/# DocProject is a documentation generator add-inDocProject/buildhelp/DocProject/Help/*.HxTDocProject/Help/*.HxCDocProject/Help/*.hhcDocProject/Help/*.hhkDocProject/Help/*.hhpDocProject/Help/Html2DocProject/Help/html# Click-Once directorypublish/# Publish Web Output*.[Pp]ublish.xml*.azurePubxml# Note: 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# Microsoft Azure Web App publish settings. Comment the next line if you want to# checkin your Azure Web App publish settings, but sensitive information contained# in these scripts will be unencryptedPublishScripts/# NuGet Packages*.nupkg# NuGet Symbol Packages*.snupkg# The packages folder can be ignored because of Package Restore**/[Pp]ackages/*# except build/, which is used as an MSBuild target.!**/[Pp]ackages/build/# Uncomment if necessary however generally it will be regenerated when needed#!**/[Pp]ackages/repositories.config# NuGet v3's project.json files produces more ignorable files*.nuget.props*.nuget.targets# Microsoft Azure Build Outputcsx/*.build.csdef# Microsoft Azure Emulatorecf/rcf/# Windows Store app package directories and filesAppPackages/BundleArtifacts/Package.StoreAssociation.xml_pkginfo.txt*.appx*.appxbundle*.appxupload# Visual Studio cache files# files ending in .cache can be ignored*.[Cc]ache# but keep track of directories ending in .cache!?*.[Cc]ache/# OthersClientBin/~$**~*.dbmdl*.dbproj.schemaview*.jfm*.pfx*.publishsettingsorleans.codegen.cs# Including strong name files can present a security risk# (https://github.com/github/gitignore/pull/2483#issue-259490424)#*.snk# Since there are multiple workflows, uncomment next line to ignore bower_components# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)#bower_components/# RIA/Silverlight projectsGenerated_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*.XMLUpgradeLog*.htmServiceFabricBackup/*.rptproj.bak# SQL Server files*.mdf*.ldf*.ndf# Business Intelligence projects*.rdl.data*.bim.layout*.bim_*.settings*.rptproj.rsuser*- [Bb]ackup.rdl*- [Bb]ackup ([0-9]).rdl*- [Bb]ackup ([0-9][0-9]).rdl# Microsoft FakesFakesAssemblies/# GhostDoc plugin setting file*.GhostDoc.xml# Node.js Tools for Visual Studio.ntvs_analysis.datnode_modules/# Visual Studio 6 build log*.plg# Visual Studio 6 workspace options file*.opt# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)*.vbw# Visual Studio 6 workspace and project file (working project files containing files to include in project)*.dsw*.dsp# Visual Studio 6 technical files*.ncb*.aps# Visual Studio LightSwitch build output**/*.HTMLClient/GeneratedArtifacts**/*.DesktopClient/GeneratedArtifacts**/*.DesktopClient/ModelManifest.xml**/*.Server/GeneratedArtifacts**/*.Server/ModelManifest.xml_Pvt_Extensions# Paket dependency manager**/.paket/paket.exepaket-files/# FAKE - F# Make**/.fake/# CodeRush personal settings**/.cr/personal# Python Tools for Visual Studio (PTVS)**/__pycache__/*.pyc# Cake - Uncomment if you are using it#tools/**#!tools/packages.config# Tabs Studio*.tss# Telerik's JustMock configuration file*.jmconfig# BizTalk build output*.btp.cs*.btm.cs*.odx.cs*.xsd.cs# OpenCover UI analysis resultsOpenCover/# Azure Stream Analytics local run outputASALocalRun/# MSBuild Binary and Structured Log*.binlogMSBuild_Logs/# AWS SAM Build and Temporary Artifacts folder.aws-sam# NVidia Nsight GPU debugger configuration file*.nvuser# MFractors (Xamarin productivity tool) working folder**/.mfractor/# Local History for Visual Studio**/.localhistory/# Visual Studio History (VSHistory) files.vshistory/# BeatPulse healthcheck temp databasehealthchecksdb# Backup folder for Package Reference Convert tool in Visual Studio 2017MigrationBackup/# Ionide (cross platform F# VS Code tools) working folder**/.ionide/# Fody - auto-generated XML schemaFodyWeavers.xsd# VS Code files for those working on multiple tools.vscode/*!.vscode/settings.json!.vscode/tasks.json!.vscode/launch.json!.vscode/extensions.json!.vscode/*.code-snippets# Local History for Visual Studio Code.history/# Built Visual Studio Code Extensions*.vsix# Windows Installer files from build outputs*.cab*.msi*.msix*.msm*.msp# Official VS Code C# Dev Kit Extension exclusion#*.lscache
模板来源: github/gitignore/VisualStudio.gitignore @356fd7b (2026-09-11) · CC0-1.0