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

Question

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

Answer 1

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

例子：

    dartdoc:

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

从这里下载文件

Answer 2

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

如果您想排除单个库（特定的 .dart 文件），您可以使用@nodoc该包将识别的符号。对于排除整个文件夹，您可以将它们移动到目录lib/src中，然后将不会记录库，请参阅此。