未找到 C# 文档 <include>

标签 c# xml documentation xml-documentation

我有一个小问题,我不明白。

我想使用文档注释来记录我的代码。我有一个 XML 文件,其中包含有关编写该部分代码的作者的信息。

我使用的是 Visual Studio 2013,并且在项目中有一个名为 Documentation 的目录,其中包含具有以下结构的文件 Author.xml:

<doc>
  <member name="number1">
    <remarks>some Information</remarks>
  </member>
  <member name="number2">
    <remarks>some Information</remarks>
  </member>
    ...
</doc>

在我的代码中我有这个评论

/// <summary>
/// 
/// </summary>
/// <include file='~/Documentation/Author.xml'path='doc/member[@name="number1"]/*'/>
public class ExampleClass { ... }

但是在documentation.xml中生成的是:

<summary>
</summary>
<!-- Der enthaltene XML-Abschnitt konnte nur teilweise oder gar nicht eingefügt werden. --><include file="~/Documentation/Author.xml" path="doc/member[@name=&quot;number1&quot;]/*"/>

这意味着无法包含 XML 代码。

我从一本关于 C# 初学者的书中得到了这个,但它不起作用。

请有人帮我解决我的问题。

最佳答案

  <include file='~/Documentation/Author.xml'path='doc/member[@name="number1"]/*'/

我可以看到两个问题:

  1. ~在 Windows 路径中没有任何特殊含义:最好使用相对于项目的路径。

  2. 您需要在一个属性和另一个属性之间留一个空格:更改 …xml'path=……xml' path=… .

关于未找到 C# 文档 <include>,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/30506584/

相关文章:

javascript - 使用 JSDoc 记录对象中包含的函数

c# - 如何配置我的 ASP.NET 目录以允许写入日志文件?

c# - 未为迁移的 (project.json -> .csproj) asp.net core 应用程序生成 web.config

c# - 使用 'Name' 属性时 SmtpClient 发送的附件顺序不正确

java - 如何获取OMElement值?

java - JAXB : IllegalAnnotationExceptions

c# - 使用 WebApi ( $inlinecount ) 的 OData 分页

xml - Groovy:将 XML 节点附加到现有 XML 文档

matlab - 解决与内置函数的名称冲突,另请参阅文档部分

python - 如何将 Python 文件文档字符串转换为 HTML