F# XML 文档

2024 年 8 月 29 日 | 阅读 2 分钟

在 F# 中，你可以从三斜杠 (///) 代码注释生成文档。XML 注释可以位于代码文件 (.fs) 或签名文件 (.fsi) 中的声明之前。

有两种编写 xml 文档注释的方法。

一种是直接在三斜杠注释中编写代码，另一种是使用 xml 标签。

F# XML 文档标签表

标签语法描述
<c>text</c>它指定 text 是代码。文档生成器可以使用此标签以适合代码的字体显示文本。
<summary>text</summary>它指定 text 是程序元素的简要描述。 描述通常是一两句话。
<remarks>text</remarks>它指定 text 包含有关程序元素的补充信息。
<param name="name">description</param>它指定函数或方法参数的名称和描述
<typeparam name="name">description ***</typeparam>*它指定类型参数的名称和描述。
<returns>text</returns>它指定 text 描述函数或方法的返回值。
<exception cref="type">description</exception>它指定可以生成的异常的类型以及引发异常的情况。
<see cref="reference">text</see>它指定指向另一个程序元素的内联链接。 reference 是它在 XML 文档文件中出现的名称。 text 是链接中显示的文本。
<seealso cref="reference"/>它指定指向另一个类型的文档的“参见”链接。 reference 是它在 XML 文档文件中出现的名称。“参见”链接通常出现在文档页面的底部。
<para>text</para>它指定一段文本。 这用于分隔 remarks 标签内的文本。

F# XML 文档示例

下一个主题F# 面试题





相关帖子




Logo

我们提供所有技术（如 Java 教程、Android、Java 框架）的教程和面试问题

联系信息

G-13, 2nd Floor, Sec-3, Noida, UP, 201301, India

hr@tpointtech.com

+91-9599086977

关注我们
Tpoint Tech Facebook PageTpoint Tech X PageTpoint Tech Linkedin PageTpoint Tech Telegram ChannelTpoint Tech Youtube ChannelTpoint Tech instagram Page
教程
Java 数据结构 C 语言 C++ 教程 C# 教程 PHP 教程HTML 教程 JavaScript 教程jQuery 教程Spring 教程
面试题
Microsoft Amazon Adobe Intuit Accenture Cognizant Capgemini Wipro Tcs Infosys
在线编译器
C R C++ Php Java Html Swift Python JavaScript TypeScript
最新帖子 | 教程列表 | 隐私政策 | 关于我们 | 联系我们
© 版权所有 2011 - 2025 TpointTech.com。保留所有权利。