flutter - Flutter Dartdoc：如何在有状态的小部件中记录状态对象？

Question

这是一个项目的一部分，我正在为教育目的构建 Flickr 应用程序的克隆。

我第一次玩 Dartdoc 和文档概念，我设法使用 Dartdoc 并为我的项目创建了一个包含文档的 Doc 文件夹。但是，对于我所有的有状态小部件，小部件本身已经正确记录了但是状态对象（我有我的构建方法、我的 initstate 方法和我的状态变量的对象），我没有得到任何文档，是默认行为还是我做错了什么？我想为这个状态对象、它里面的方法和里面的变量生成文档。

除此之外，我收到了一些警告，我将进一步研究这些警告，如果无法解决它们，我将打开一个单独的问题。

这是我使用 Dartdoc 的方式：

Dartdoc 命令

Dartdoc 命令结束

生成的文档

生成的文档_方法

如果我的问题很愚蠢，请原谅我，这是我第一次使用文档：D

编辑：我正在做的一个天真的解决方案是，我将大部分变量和方法移动到小部件对象而不是状态对象。这是解决这个问题的正确方法吗？

标签： flutterdartdocumentationdocumentation-generationdartdoc

Answer 1

您的State课程是私有的 ( _FlickrCameraScreen)，因此它不会生成公共文档。如果你想要它的公共文档，你需要将它重命名为FlickrCameraScreenState. 如果您需要将创建限制在您的FlickrCameraScreen小部件中，您可以给它一个私有构造函数。