Azure Repo中C/C++项目发布至Wiki的无冗余方案咨询

无需生成大量MD文件的同步方法 #

• 用Azure Repo符号链接直接关联代码元素：不需要把cpp转成MD，直接在Git Wiki的MD文件里用符号链接语法指向函数、类等代码元素。格式如下：

  [目标函数/类名](https://dev.azure.com/[你的组织名]/[项目名]/_git/[仓库名]?path=/[文件相对路径]&symbol=[函数/类名称]&version=GB[目标分支名])
  

  这种链接会自动跟踪代码变更，只要符号名称（函数/类名）不变，哪怕代码行号因修改变动，链接依然能定位到最新的代码位置，完全不用维护静态MD副本。

• Wiki内嵌代码片段+符号链接：如果需要在Wiki里展示部分代码，直接在MD中插入代码块，再用符号链接指向完整代码的最新位置，示例：

  > 核心逻辑实现片段：
  > ```cpp
  > int calculateTotal(int a, int b) {
  >     return a + b * 2;
  > }
  > ```
  > 查看完整代码：[calculateTotal](https://dev.azure.com/MyOrg/MyProj/_git/MyRepo?path=/src/Calc.cpp&symbol=calculateTotal&version=GBmain)
  

  只需要维护少量汇总Wiki页面，不用为每个cpp单独建MD。

• 批量生成符号链接脚本（可选）：如果要批量处理大量代码元素，写个简单的Python/PowerShell脚本，遍历cpp文件提取函数/类名，自动生成带符号链接的MD片段，插入到主Wiki页面里就行，不会产生额外文件。

关于“为何要转代码为MD再提交Git”的解惑 #

Azure Wiki的Git仓库模式只认MD格式，早期符号链接功能不完善时，部分用户会把代码转成带高亮的MD代码块提交到Wiki仓库，目的是在Wiki里展示代码内容。但这种方法生成的是静态副本，代码更新后MD不会同步，还会污染仓库，属于过时的替代方案。

现在Azure Repo已经支持直接链接代码中的符号，完全没必要再转MD，之前的做法只是历史遗留的临时解决方案。

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