我们如何获得有意义的评论以在 Azure APIM 中显示
How do we get meaningful comments to show in Azure APIM
我们正在使用 azure APIM 和关联的开发人员门户。
我真的很想在开发门户中向我们的用户展示有意义的、格式良好的文档,但是我很难找到关于如何做到这一点的任何好的信息或示例。
我们有针对正在输出的端点的代码注释,但样式与我所期望的不一致,例如,通常 XML 像这样的注释
/// <summary>
/// This is a summary of the endpoint
/// </summary>
/// <remarks>
/// <para>This is paragraph one</para>
/// <para>This is paragraph two</para>
/// <remarks>
应该导致包含两段的备注部分,我们最终得到的是(显然无法识别和未解析的)XML 节点 <para>
被渲染出来,所以我们得到:
This is a summary of the endpoint
This is paragraph one This is paragraph two
目前我一直在试错,因为我找不到任何具体的文档,我一直在使用这个 Recommended Tags for C# 作为参考,但它似乎不能很好地转化为 APIM 开发门户。
我希望能够添加代码示例、格式化文本(没什么特别的.. 换行符将是一个开始)
任何指导将不胜感激,因为实际上我们受困于 APIM Dev Portal,因此我将不得不解决一些问题。
理想情况下,我还希望从单独的文件中引用这些评论,因为我们试图让我们的 API 控制器保持轻量级,目前其中一个有 200 行长,其中 150 行是评论! - 但那是我改天再担心的事情!
为了将来参考,这是我在试验评论时发现的 - 与我在原始问题中所经历的有点不同(我猜我一定是搞砸了)。
我们正在使用 azure APIM 和关联的开发人员门户。
我真的很想在开发门户中向我们的用户展示有意义的、格式良好的文档,但是我很难找到关于如何做到这一点的任何好的信息或示例。
我们有针对正在输出的端点的代码注释,但样式与我所期望的不一致,例如,通常 XML 像这样的注释
/// <summary>
/// This is a summary of the endpoint
/// </summary>
/// <remarks>
/// <para>This is paragraph one</para>
/// <para>This is paragraph two</para>
/// <remarks>
应该导致包含两段的备注部分,我们最终得到的是(显然无法识别和未解析的)XML 节点 <para>
被渲染出来,所以我们得到:
This is a summary of the endpoint
This is paragraph one This is paragraph two
目前我一直在试错,因为我找不到任何具体的文档,我一直在使用这个 Recommended Tags for C# 作为参考,但它似乎不能很好地转化为 APIM 开发门户。
我希望能够添加代码示例、格式化文本(没什么特别的.. 换行符将是一个开始)
任何指导将不胜感激,因为实际上我们受困于 APIM Dev Portal,因此我将不得不解决一些问题。
理想情况下,我还希望从单独的文件中引用这些评论,因为我们试图让我们的 API 控制器保持轻量级,目前其中一个有 200 行长,其中 150 行是评论! - 但那是我改天再担心的事情!
为了将来参考,这是我在试验评论时发现的 - 与我在原始问题中所经历的有点不同(我猜我一定是搞砸了)。