如何为项目中所有包生成统一的Dart文档？

针对你的项目结构，可通过以下步骤生成包含所有目标库的统一dartdoc文档：

1. 创建统一入口桶文件 #

在项目根目录新建doc_entrypoint.dart，通过导出语句聚合所有需要生成文档的库：

// 导入lib目录下的主库
export 'lib/main.dart';
// 导入packages目录下的功能包
export 'packages/feature_name/feature_name.dart';
// 后续新增包时，在此添加对应export语句即可

2. 配置dartdoc_options.yaml #

在项目根目录的dartdoc_options.yaml中指定入口文件并开启外部文件包含：

dartdoc:
  entryPoint: doc_entrypoint.dart
  includeExternal: true

此配置会让dartdoc以桶文件为起点，解析所有导出的关联库，无需逐个指定文件。

3. 执行文档生成命令 #

在项目根目录运行以下命令即可生成统一文档：

dart doc

注意事项 #

• 确保packages目录下每个子包的pubspec.yaml配置正确，dartdoc可正常识别其库结构
• 若后续新增子包或lib下的库，只需更新doc_entrypoint.dart的导出语句即可

内容的提问来源于stack exchange，提问作者Damian K. Bast