本文概述
在F#中, 你可以使用三斜杠(///)代码注释生成文档。 XML注释可以在代码文件(.fs)或签名(.fsi)文件中的声明之前。
有两种编写xml文档注释的方法。
一种方法是只用三斜杠注释编写代码, 第二种方法是使用xml标记。
F#XML文档标签表
标签语法 | 描述 |
---|---|
<c>text</c> | 它指定文本是代码。文档生成器可以使用此标记以适合代码的字体显示文本。 |
<summary>text</summary> | 它指定文本是对程序元素的简短描述。描述通常是一两个句子。 |
<remarks>text</remarks> | 它指定文本包含有关program元素的补充信息。 |
<param name=”name”>description</param> | 它指定函数或方法参数的名称和描述 |
<typeparam name =“ name”>说明*** </ typeparam> * | 它指定类型参数的名称和描述。 |
<returns>text</returns> | 它指定文本描述函数或方法的返回值。 |
<exception cref=”type”>description</exception> | 它指定了可以生成的异常类型以及抛出异常的环境。 |
<see cref =“ reference”>文本</ see> | 它指定到另一个程序元素的内联链接。该引用是XML文档文件中显示的名称。文本是链接中显示的文本。 |
<seealso cref =“ reference” /> | 它指定另一个类型的文档的另请参阅链接。该引用是XML文档文件中显示的名称。另请参见链接通常出现在文档页面的底部。 |
<para>text</para> | 它指定一段文本。这用于分隔备注标记内的文本。 |
F#XML文档示例
let a = 10 /// This is a integer variable.
评论前必须登录!
注册