未找到C#文档<include>

时间:2015-05-28 12:26:38

标签: c# xml documentation xml-documentation

嗨,我有一点我不明白的问题。

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

我正在使用VisualStudio 2013并且在项目中有一个名为Documentation的难处文件,其中包含具有以下结构的File 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中是Generated:

<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#书中得到了这个,但它不起作用。

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

1 个答案:

答案 0 :(得分:2)

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

我可以看到两个问题:

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

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