标签: xml-documentation

我在VS 2005下用C#编写了一个类库(我知道,现代化,但我们这里的预算很紧张).

在我看来,如果我在XML文档中使用"summary"标记,我的用户可以通过Intellisense和工具提示等查看该信息,但不能在Studio的"属性"窗口中看到.

要在该窗口中获取某些内容,我似乎需要使用[Description("This is it")]属性.

我对此是否正确？如果是这样,那么我似乎需要复制描述信息:-(

或者,还有更好的方法？谢谢!

注意:这是此问题的副本,但对于Visual Basic而不是C#.

编写可以使用的XML文档时<see cref="something">something</see>,当然可以使用.但是,如何引用具有泛型类型的类或方法？

Public Class FancyClass(Of T)

  Public Function  FancyMethod(value As T) As String
    Return "something fancy"
  End Function

End Class

如果我要在某处写xml文档,我将如何引用这个花哨的类？我该如何参考FancyClass(Of String)？方法怎么样？

例如,在另一个类中,我想让用户知道我将返回一个实例FancyClass(Of Integer).我怎么能see cref为此做点什么呢？

我正在尝试使用Microsoft ASP.NET Web API 2.2 帮助页面 5.2.3为 RESTful Web 服务构建 API 文档。看起来<summary>和<param>元素的内容包含在文档中，但该<remarks>部分完全被忽略，在我期望的描述中<returns>，我看到了<summary>. 我找不到任何解释帮助页面支持哪些 XML 注释标签的文章（或者注释控制器与注释常规代码有何不同）。我想知道是否有人可以分享任何指针，特别是可以使用哪些标签，如何引用其他页面等。

我正在阅读有关具有以下语法的标记的 C# 规范<permission>：

<permission cref="member">description</permission> 

据说：

该标签允许记录成员的安全可访问性，其中cref="member"是成员的名称，而description是对该成员的访问的描述。

所以我可以说这样的事情可能是有效的：

/// <permission cref="foo">foo is not accessible</permission>
private void foo() {}

但是在规范中有以下示例：

/// <permission cref="System.Security.PermissionSet">Everyone can 
/// access this method.</permission> 
public static void Test() { } 

如果cref是必须记录可访问性的成员，那么System.Security.PermissionSet它会做什么？

我真的不明白规范示例！

因此，我想记录我的类的方法，以便它可以与 Help Insight 一起使用。然后我发现了 XML 文档，因此我尝试使用它，但由于某种原因它对我不起作用。

然后，我尝试制作一些更简单的项目，而不是将此文档添加到现有项目中，并且效果很好，因此通过实验我发现这是因为我的类是通用的。有谁知道如何解决它？我的意思是..这并不重要，但如果能用有效的 Help Insight 记录代码就好了...

我添加了我制作的示例项目的代码

interface
  type
   whatever = class
     public
     /// <summary> Remoified item from the collection </summary>
     /// <param name="Item">The item  remove </param>
     /// <param name="Collection"> item </param>
     /// <remarks> If parameter "Item" an exception is raised.
     /// <see cref="EArgumentNilException"/> </remarks>
     /// <returns> False is returned. </returns>
     function test(Item: Pointer; Collection: Pointer): Boolean;
   end;

   whatever<e> = class
     public
     /// <summary> from the collection </summary>
     /// <param name="Item">Te </param>
     /// <param name="Collection"> item …

我正在寻找一种在 C# 中记录操作参数的方法。代码如下所示：

/// <summary>
/// Do some action with parameters.
/// </summary>
/// <params name="someAction"> This is action but what about parameters? </param>
public void Do(Action<int,int,string> someAction)

如何命名和记录“someAction”的参数，以便它们出现在智能感知中？

我正在为 C# 项目编写一个小型分析器，用于检查 XML 文档生成是否存在且设置正确。有两个选项可用于指定 XML 文档：

• 较旧的DocumentationFile选项
• 较新的GenerateDocumentationFile旗帜。如果该标志设置为 true，MSBuild 应在项目的输出目录中生成一个带有项目名称的 XML 文档文件。

这两个选项都可以在项目文件中明确指定吗？这些选项的值会被合并还是其中一个选项将被忽略？

我正在尝试使用<example>标记内的<code>标记在xml文档中显示示例代码.但是,当我构建Sandcastle项目时,我发现它显示为C#.<code>标记中没有语言属性.我在Sandcastle的项目属性中找不到设置.我错过了什么吗？

顺便说一下,我使用的是HtmlHelp1格式.

/// <summary>
/// 
/// </summary>
/// <remarks
/// 
/// </remarks>

如何在上面的注释中添加xaml代码,避免代码解析器创建不存在的链接(CTRL + Click消息)？

我使用了以下XML评论,

    /// <example> 
    /// This example shows how to use <see cref="SampleCollection"/> property.
    /// <code>
    /// class TestClass 
    /// {
    ///      List<string> collection = new List<string>();
    ///      collection.Add("Column1");
    ///      collection.Add("Column2");
    ///      this.SampleCollection = collection;
    /// }
    /// </code>
    /// </example>        
    public List<string> SampleCollection
    {
        get;
        set;
    }

但它有以下警告错误,

关于'SampleCollection'的XML注释格式错误 - '结束标记'代码'与开始标记'字符串'不匹配.

因为List定义有<string>.所以它认为是XML标签.

有什么方法可以解决这个问题吗？