如何配置dart doc使其按实际目录结构展示lib下的库文件?
Dart Doc 实现库文件按目录层级展示的方法
默认情况下,dart doc会将lib下所有源码文件平级展示在「Libraries」分类下,要实现按目录分组的层级展示,可以试试以下两种方法:
方法一:通过导出结构模拟目录层级
不需要依赖文件目录本身,而是通过创建目录入口导出文件来组织结构:
- 在每个子目录下创建入口文件,比如
lib/directoryA/directoryA.dart,在其中导出该目录下的所有文件:export 'A.dart'; // 若目录内有其他文件,一并导出即可 - 同样在
lib/directoryB/下创建directoryB.dart,导出B.dart; - 在项目根
lib/目录的主导出文件(比如your_package.dart)中,按层级导出这些目录入口文件:export 'directoryA/directoryA.dart'; export 'directoryB/directoryB.dart';
生成文档后,dart doc会识别这种导出结构,将同一入口下的文件归为一组,呈现出类似目录层级的展示效果。
方法二:使用@category注解手动分组
通过给每个文件添加库级注释的@category标签,指定其所属分组:
- 在
A.dart的顶部添加库注释:/// @category DirectoryA library directoryA.A; - 在
B.dart的顶部添加对应注释:/// @category DirectoryB library directoryB.B;
这种方式需要逐个文件配置注解,适合文件数量较少的项目,dart doc会根据@category的取值将文件分组展示。
内容的提问来源于stack exchange,提问作者MinisX
相关产品推荐
相关产品推荐

