Visual Studio Team Services如何发布代码文档

问题描述 投票:2回答:1

我的目的是改进我们的Visual Studio C#解决方案的代码文档。因此,我想将基于xml的C#文档上载到Visual Studio Team Services。

选项1:Doxygen

  • 有一个doxygen包,可以添加到构建定义中
  • 然后文档作为pdf文件包含在vsts的菜单中。

但我正在寻找更多的解决方案,将代码文档构建为html文件,并将其发布到VSTS的项目维基中。

选项2:首选但未找到

  • 将文档创建为html文件
  • 将其添加到VSTS项目Wiki或仪表板

是否有VSTS实施选项2的包?有人可以描述方式,如何实施选项2?

visual-studio build azure-devops code-documentation
1个回答
0
投票

VSTS项目维基不支持html文件,但它支持一些HTML标记,因此您可以创建带有HTML标记的Wiki页面。

例如:

<p>This text needs to <del>strikethrough</del> <ins>since it is redundant</ins>!</p>
<p><tt>This text is teletype text.</tt></p>
<font color="blue">Colored text</font>
<center>This text will be center-aligned.</center>
<p>This text contains <sup>superscript</sup> text.</p> 
<p>This text contains <sub>subscript</sub> text.</p>
<p>The project status is <span style="color:green;font-weight:bold">GREEN</span> even though the bug count / developer may be in <span style="color:red;font-weight:bold">red.</span> - Capability of span
<p><small>Disclaimer: Wiki also supports showing small text</small></p>
<p><big>Bigger text</big></p> 

Syntax guidance for Markdown files, widgets, wikis, and pull request comments

由于每个团队项目wiki都使用git存储库后端,因此您可以脱机更新它(克隆>修改/创建文件>提交>推送)。

Clone and update wiki pages offline

© www.soinside.com 2019 - 2024. All rights reserved.