如何不使用Dartdoc在Flutter项目中添加每个库

Question

当我启动命令dartdoc --auto-include-dependencies时，我如何才能不为项目中的每个库创建文档呢？我在我的项目中使用Melos。

Answer 1

请仔细查看pub.dev上的dartdoc包的文档。这是link。

如果您想要排除单个库(特定的.dart文件)，您可以使用@nodoc表示法，它将被包识别。要排除整个文件夹，您可以将它们移动到lib/src目录中，然后这些库将不会被记录，请参见this。

Answer 2

从dartdoc 0.35.0开始，您可以将nodoc定义为选项，并在dartdoc_options.yaml中使用通配符*.dart传递dart文件的路径数组。这将处理那些标记为/@nodoc的文件。基本上节省了我们在所需文件中编写/@nodoc的时间

示例：

    dartdoc:

      nodoc: [ 'lib/utils/*.dart','lib/views/**/*.dart','lib/constants/*.dart' ]

从here下载文件