自我记录asp.net api

时间:2017-07-31 19:50:27

标签: c# asp.net xml api self-documenting-code

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

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

项目的App_Data文件夹中没有XmlDocument.xml,因此我创建了一个带有我在其他apis中自我记录xml的标签

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

但是在构建和/或运行应用程序时,没有任何内容进入xml。我的理解是,当基于每个///的给定方法的摘要打开XML sel文档时,对于没有摘要的任何公共方法都有智能感知警报,但我找不到任何明确复制的代码这个xml的摘要信息是“成员”标签内的“成员”标签,也不会发生。我错过了哪一步,我没有看到如何在互联网上打开APi中的自我文档?

2 个答案:

答案 0 :(得分:1)

在项目属性中,将XML文档destintion文件夹重命名为所需的文件夹。我想最好使用app_data而不是App_code文件夹。

查看this question answer

的第一步和第二步

答案 1 :(得分:0)

尝试删除您添加的XmlDocument.xml文件(我认为这会自动生成),并在项目设置中指定其路径 - &gt;在输出部分中构建标签。