Flutter注释文档生成

本文最后更新于：2 年前

一、注释类别

Dart支持单行注释、多行注释和文档注释，官方提供了相关注释的说明文档Effective Dart

1
2
3
4
5
6
7
8
// 单行注释

/*
多行注释
*/
  
由于历史原因，dartdoc支持两种文档注释语法，（/// “ C＃样式”）和/** ... */（“ JavaDoc样式”），推荐适用///
/// 文档注释
  • 单行注释用法简单，适用于方法、类等内部实现使用，推荐作为内部补充说明
  • 多行注释一般用于大段说明文字等，不推荐适用
  • 文档注释以///开头，推荐适用于类、方法等

二、注释文档生成

dartdoc脚本可以从Dart源代码中提取文档注释生成API参考文档

  1. dart sdk环境

需要保证本地dart环境正常，如果本地能执行flutter doctor命令，那么就能正常使用dartdoc命令

  1. 路径

dartdoc脚本在sdk安装包中的路径如下：~/flutter/bin/cache/dart-sdk/bin/dartdoc，请对照本地部署包得到实际路径

  1. 执行如下命令行
1
2
// 进入flutter工程目录下
$ cd ~/Desktop/demo_dartdoc
1
2
// 直接调用sdk中的dartdoc工具
$ ~/flutter/bin/cache/dart-sdk/bin/dartdoc
  1. 打开生成的doc文件夹，可以找到所有生成好的注释文档，其中library即为工程中个性化的类的相关注释说明，或者按照文件夹目录直接打开对应的html文件也可