dartdoc

dartdoc命令从Dart源代码创建API参考文档. 您可以使用文档注释添加描述到生成的文档中,其中可以包含markdown格式. 有关编写文档注释的指导,请参见Effective Dart文档部分 .

从包的根目录运行dartdoc . 例如:

$ cd my_app
$ dartdoc
Documenting my_app...
...
Success! Docs generated into /Users/me/projects/my_app/doc/api

默认情况下,文档文件是静态HTML文件,位于doc/api目录中. 要查看呈现的文档,您需要一个HTTP服务器.

尽管dartdoc在Dart SDK中,但在dartdoc包中也可以使用. 当您需要编程界面或尝试使用SDK版本dartdoc尚未提供的功能时,可以使用该软件包.

有关命令行选项的信息,请使用--help标志:

$ dartdoc --help

by  ICOPY.SITE