26

在具有单个构造函数的 C# 类中，我可以添加类摘要 XML 文档和构造函数 XML 文档：

///<summary>
///This class will solve all your problems
///</summary>
public class Awesome
{
    /// <summary>
    /// Initializes a new instance of the <see cref="Awesome"/> class.
    /// </summary>
    /// <param name="sauce">The secret sauce.</param>       
    public Awesome(string sauce)
    {
        //...implementation elided for security purposes
    }
}

如何对等效的 F# 类执行相同操作以使生成的文档相同？

type Awesome(sauce: string) = 
    //...implementation elided for security purposes

澄清：我知道标准 XML 文档标签可以在 F# 中使用。我的问题是如何将它们添加到上面的代码片段中，以便记录类型和构造函数。

4

4 回答 4

17

我查看了开源 F# 编译器的源代码，我认为 Dr_Asik 是正确的 - 无法使用 XML 注释记录隐式构造函数。代表 AST 中的隐式构造函数的节点（参见ImplicitCtor此处ast.fs ）不包括用于检索 XML 文档的字段（表示为PreXmlDoc类型）。

您仍然可以记录所有公共 API - 您必须使用 Dr_Asik 提到的方法并将隐式构造函数标记为private. 我同意这有点难看，但我认为它比不使用隐式构造函数更方便：

type MyType private(a:int, u:unit) =
  /// <summary>Creates MyType</summary>
  /// <param name="a">Parameter A</param>
  new(a:int) = MyType(a, ())

我在隐式构造函数中添加了一个虚拟参数u，以便可以从公共构造函数中调用它。无论如何，我认为这应该被视为一个语言错误，所以我建议将此报告给fsbugsat microsoftdot com。

顺便说一句，我认为 XML 文档主要用作 IntelliSense 的数据源（尽管它仍然需要构造函数的文档），并且我创建了一些替代 F# 工具，让您可以通过编写 F# 脚本文件来创建教程和文档使用 Markdown 进行特殊评论（有一篇关于它的博客文章） - 所以您可以认为这是对标准 XML 工具的有用补充。

于 2013-02-28T02:12:19.253 回答
14

与您在 C# 中所做的方式完全相同：http: //msdn.microsoft.com/en-us/library/dd233217.aspx

如果您不添加任何标签，F# 会假定它是“摘要”：

/// This is the documentation
type MyType() = ....

... 相当于

/// <summary>This is the documentation</summary>
type MyType() = ...

如果要记录构造函数，则必须显式声明它。AFAIK 没有办法记录主构造函数。

/// [Type summary goes here]
type MyType(a : int) =
    let m_a = a
    /// [Parameterless constructor documentation here]
    new() = MyType(0)
于 2013-02-27T20:37:33.180 回答
9

无法在 F# 源文件 (.fs) 中使用 XML 注释记录隐式构造函数。一种解决方法是显式声明构造函数（参见 Asik 博士的回答）。另一种是将您的 XML 注释放入 F# 签名文件 (.fsi)。

文件.fs：

module File

type Awesome(sauce: string) =
    member x.Sauce = sauce

文件.fsi

module File

type Awesome =
  class
    /// Implicit constructor summary for the Awesome type
    new : sauce:string -> Awesome
    member Sauce : string
  end

此程序集的 XML 文档现在将包含正确的摘要：

<member name="M:File.Awesome.#ctor(System.String)">
<summary>
 Implicit constructor summary for the Awesome type
</summary>
</member>
于 2013-02-28T14:55:19.727 回答
4

这确实是一个烦人的问题。我最终使用的另一个解决方案是不依赖主构造函数：

/// Documentation type.
type Awesome =
    val sauce : string
    /// <summary>Documentation constructor.</summary>
    /// <param name="sauce">Sauce. Lots of it.</param>
    new (sauce) = { sauce = sauce }

更详细，但不需要额外的文件或私有构造函数......

于 2013-08-05T14:20:14.003 回答