Flutter Dart 文档:如何在 Stateful Widget 中记录状态对象?
Flutter Dartdoc: How to Document State Objects in Statefull Widgets?
这是一个项目的一部分,我正在为教育目的构建 Flickr 应用程序的克隆。
我第一次接触 Dartdoc 和一般的文档概念,我设法使用 Dartdoc 并为我的项目创建了一个包含文档的 Doc 文件夹。然而,对于我所有的有状态小部件,小部件本身已经正确记录了状态对象(我有我的构建方法、我的 initstate 方法和我的状态变量的对象),我没有得到任何文档,是吗默认行为还是我做错了什么?我想为这个状态对象生成文档,里面的方法,里面的变量。
除此之外,我收到了一些警告,我将进一步搜索这些警告,如果无法解决它们,我将另开一个问题。
以下是我使用 Dartdoc 的方式:
Dartdoc 命令
Dartdoc 命令结束
生成的文档
生成的文档_方法
如果我的问题很愚蠢,请原谅我,这是我第一次使用文档:D
编辑: 我正在做的一个天真的解决方案是,我将大部分变量和方法移到了小部件对象我的状态对象。这是解决此问题的正确方法吗?
您的 State
class 是私有的 (_FlickrCameraScreen
),因此它不会生成 public 文档。如果你想要它的 public 文档,你需要将它重命名为 FlickrCameraScreenState
。如果您需要将创建限制为您的 FlickrCameraScreen
小部件,您可以给它一个私有构造函数。
这是一个项目的一部分,我正在为教育目的构建 Flickr 应用程序的克隆。
我第一次接触 Dartdoc 和一般的文档概念,我设法使用 Dartdoc 并为我的项目创建了一个包含文档的 Doc 文件夹。然而,对于我所有的有状态小部件,小部件本身已经正确记录了状态对象(我有我的构建方法、我的 initstate 方法和我的状态变量的对象),我没有得到任何文档,是吗默认行为还是我做错了什么?我想为这个状态对象生成文档,里面的方法,里面的变量。
除此之外,我收到了一些警告,我将进一步搜索这些警告,如果无法解决它们,我将另开一个问题。
以下是我使用 Dartdoc 的方式:
Dartdoc 命令
Dartdoc 命令结束
生成的文档
生成的文档_方法
如果我的问题很愚蠢,请原谅我,这是我第一次使用文档:D
编辑: 我正在做的一个天真的解决方案是,我将大部分变量和方法移到了小部件对象我的状态对象。这是解决此问题的正确方法吗?
您的 State
class 是私有的 (_FlickrCameraScreen
),因此它不会生成 public 文档。如果你想要它的 public 文档,你需要将它重命名为 FlickrCameraScreenState
。如果您需要将创建限制为您的 FlickrCameraScreen
小部件,您可以给它一个私有构造函数。