我在 ASP.Net WebAPI 项目中使用 NSwag 来生成 swagger 界面 - 效果很好。
假设我有一个方法想要添加一些解释 - 我该怎么做？
我所说的注释是指当 API 用户查看文档时会看到的内容。
我用谷歌搜索过，狂饮过，然后……躲开了？ - 但无法找到任何相关信息。也许我使用了错误的术语。
您可以使用文档评论 https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments实现您的目标。例如
/// <summary>This method changes the point's location by
/// the given x- and y-offsets.
/// <example>For example:
/// <code>
/// Point p = new Point(3,5);
/// p.Translate(-1,3);
/// </code>
/// results in <c>p</c>'s having the value (2,8).
/// </example>
/// </summary>
public void Translate(int xor, int yor) {
X += xor;
Y += yor;
}
Translate是您的 API 方法，并且您已添加了正确的文档注释，当您通过 API 资源管理器探索 API 时，NSwag 会选取这些注释并显示它们。如果这不起作用添加在你的.csproj
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
