3.8 生成接口文档

3.8 生成接口文档

实现步骤：

注意导出的文档注释用 ///

img

第 1 步：配置 dartdoc_options.yaml

dartdoc_options.yaml

1
2
dartdoc:
  nodoc: ["lib/pages/**/*.dart"]

这里排除了 pages 目录，我们只要 common 生成定义文件就行

第 2 步：生成文档

执行命令，安装 dartdoc

1
dart pub global activate dartdoc

执行命令，生成文档到 doc/api 目录

1
dart pub global run dartdoc

生成成功

img

最后：启动一个 http 服务查看

执行命令，安装 dhttpd

1
dart pub global activate dhttpd

执行命令，运行 dhttpd

1
dhttpd --path doc/api
img

提交代码到 git