查看源代码 typer

Erlang 程序的类型注解器。

描述

TypEr 显示 Erlang 模块的类型信息。此外,它还可以使用此类类型信息来注释文件的代码。

使用 TypEr

TypEr 通过命令行使用。本节简要描述了这些选项。在 shell 中输入以下内容可以获得相同的信息

typer --help

用法

typer [--help] [--version] [--plt PLT] [--edoc]
      [--show | --show-exported | --annotate | --annotate-inc-files | --annotate-in-place]
      [-Ddefine]* [-I include_dir]* [-pa dir]* [-pz dir]*
      [-T application]* file* [-r directory*]

注意

* 表示该选项可以多次出现。

选项

  • -r - 递归地在目录下搜索 .erl 文件。如果给出了文件列表,则必须在它们之后给出此选项。

  • --show - 在 stdout 上打印所有函数的类型规范。(这是默认行为;实际上不需要此选项。)

  • --show-exported (或 show_exported) - 与 --show 相同,但仅打印导出函数的规范。规范按照函数名称的字母顺序显示。

  • --annotate - 使用类型规范注释指定的文件。

  • --annotate-inc-files - 与 --annotate 相同,但会注释所有 -include() 文件以及所有 .erl 文件。(请谨慎使用此选项 - 它未经充分测试。)

  • --annotate-in-place - 直接在源代码文件中进行注释,而不是将注释后的文件转储到不同的目录中。(请谨慎使用此选项 - 它未经充分测试。)

  • --edoc - 将类型信息打印为 Edoc @spec 注释,而不是类型规范。

  • --plt - 使用指定的 dialyzer PLT 文件,而不是默认文件。

  • -T 文件* - 指定的文件已包含类型规范,为了打印其余文件的规范,这些类型规范是可信任的。(可以指定多个文件或目录,用空格分隔。)

  • -Dname (或 -Dname=value) - 将定义的名称传递给 TypEr。(**)

  • -I - 将 include_dir 传递给 TypEr。(**)

  • -pa dir - 将 dir 包含在 Erlang 的路径中。这在分析使用 -include_lib() 指令或解析转换的文件时很有用。

  • -pz dir - 将 dir 包含在 Erlang 的路径中。这在分析使用 -include_lib() 指令或解析转换的文件时很有用。

  • --version (或 -v) - 打印 TypEr 版本和一些更多信息并退出。

注意

** 选项 -D-I 的工作方式与 erlc 中相同。