F#入门-第二章 F#基础-第二节 注释

    F#语言有两种注释方法。

    行注释为只有一行的注释。

    块注释是从"（*"到"*）"之间的注释。

   

行注释

//行注释。只注释这1行
 print_endline "hello world";;

 

块注释1

(*块注释。
这里也是注释。
*)
print_endline "hello world";;

    
     ※print_endline函数的使用方法在后文详述。

    
    一般情况下以上两种注释方法就够了。F#还具有doc_comment这种功能用来生成API注释文档。F#编译器可以将从程序中的注释抽出，生成XML文档。

a.fs:要抽出注释的源程序文件

//用utf-8保存
#light "off"
///返回数值的平方,注意此处为///，只有加了///的行能被输出
let square n=n*n;;
print_any <| square 10;;

   
    对程序的内容这里不做解释，只说明一下这是返回数值的平方的程序。
    要想将注释输出到XML文件中，请在命令行编辑窗口（cmd.exe)中，转到F#的安装目录下的bin目录中（fsc.exe工具在该目录中），并做如下工作。

输出程序注释

> fsc --doc doc.xml a.fs

    a.fs是源程序文件名，doc.xml是要输出XML的XML文件名。
    输出的XML文件内容如下

输出的XML文件

<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly><name>a</name></assembly>
<members>
<member name="M:A.square(System.Int32)">
<summary>
输出数值的平方
</summary>
</member>
<member name="T:A">
</member>
</members>
</doc>

    到VisualStudio2003版为止，都具有将注释生成API文档的功能。VisualStudio2005版以后就被废除了。因此，要想将这个XML文件生成API文档，可以使用VisualStudio2005版之后提供的NDoc等文档生成工具。

    最新版本的F#中，不能直接使用print_endline函数。要想使用print_endline函数，需要在命令行中做如下准备工作。

print_endline函数

> #r "FSharp.PowerPack.dll";;
--> Referenced 'D:\p\fsharp\bin\FSharp.PowerPack.dll'
> print_endline "Hello World";;
Hello World
val it : unit = ()

    #r,是指在命令行中追加引用的语句。print_endline函数包含在FSharp.PowerPack.dll文件中，因此引用FSharp.PowerPack.dll，从而使用print_endline函数。