从GitHub克隆Visual Studio项目后全部引用失效问题咨询

问题根因 #

该问题既不是Visual Studio没有同步引用，也不是GitHub拉取环节出错，核心是两个配置问题导致：

1. 绝大多数.NET项目会将.suo、.user等本地用户配置文件加入.gitignore过滤规则，这类文件保存了部分本地引用的路径映射缓存，你同事本地的缓存文件未提交到GitHub，你克隆后VS首次加载项目时缺少对应缓存，就会判定引用失效。
2. 项目的外部引用如果配置为绝对路径，哪怕两台设备的路径肉眼完全一致，也可能因为盘符大小写、系统隐藏权限、VS加载时的环境变量差异导致识别失败。直接复制同事的整个项目目录时，会连带本地缓存文件一起复制，因此引用可以正常加载。

可行解决方案 #

按照以下步骤配置后，即可实现克隆仓库后直接正常构建：

• 统一依赖管理方式
  优先使用DevExpress官方NuGet包管理所有控件依赖，仅需要将packages.config或者项目内的PackageReference配置提交到GitHub，克隆后VS会自动还原对应版本的依赖包，无需手动配置引用路径。
• 调整引用路径规则
  如果不使用NuGet管理，需要将所有外部引用的HintPath改为相对路径：右键失效项目选择「卸载项目」，再右键选择「编辑.csproj文件」，修改所有<Reference>节点的路径为项目根目录的相对路径，不要保留C:\开头的绝对路径配置，示例正确配置如下：

  <Reference Include="DevExpress.Data.v23.1, Version=23.1.3.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a">
    <HintPath>..\lib\DevExpress.Data.v23.1.dll</HintPath>
  </Reference>
  

• 调整.gitignore过滤规则
  不要全局过滤所有与引用配置相关的文件，可参考如下规则配置：

  # 过滤所有个人调试相关的.user配置
  *.user
  # 保留项目公共引用配置的.csproj.user文件
  !*.csproj.user
  

• 提交所有公共配置到GitHub
  将修改后的.csproj文件、.gitignore、NuGet相关配置文件全部提交到GitHub，后续克隆仓库后等待VS完成依赖自动还原，即可直接构建。

内容的提问来源于stack exchange，提问作者AwiringCameron