自我记录 asp.net api

Question

我在 VS2015 中创建了一个 Asp.net api。在 Areas>HelpPage>App_Start>HelpPageConfig.cs 我取消了第 37 行的注释

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

项目的 App_Data 文件夹中没有 XmlDocument.xml，所以我用我在其他 [=28] 中的自我记录 xml 中看到的标签创建了一个=]s

<?xml version="1.0" encoding="utf-8" ?>
<doc>
  <assembly>
    <name>NameOfApiHere</name>
  </assembly>
  <members>
  </members>
</doc>

但是在构建 and/or 运行应用程序时，没有任何内容进入 xml。据我了解，当此功能打开时，XML sel 文档基于给定方法的每个///摘要，并针对任何没有摘要但我无法识别的 public 方法发出智能警报在 "members" 标签内找不到任何将摘要信息显式复制到此 xml 作为 "member" 标签的代码，也没有发生。我错过了哪一步，我没有在互联网上的如何在 APi 中看到打开自我文档？

Answer 1

在项目属性中将 XML 文档目标文件夹重新指向您想要的文件夹。我想最好使用 app_data 而不是 App_code 文件夹。

查看 this question answer

的第 1 步和第 2 步

Answer 2

尝试删除您添加的 XmlDocument.xml 文件（我认为这会自动生成）并在项目设置中指定它的路径 -> Output 中的构建选项卡部分。

自我记录 asp.net api

Self documenting asp.net api

c#

xml

asp.net

api

self-documenting-code