第十三回 关于本系列文章中示例代码的管理方式
关于Talk Flutter系列的博客已经写了一段时间了,我准备把博客中的示例代码放到
Github
上,也就是通过Git来管理代码。其实在写第一篇博客的时候就想这样做了,只是当时不知道使用哪种方式在App中呈现示例界面。本章回中主介绍GitHub的代码目录以及示例App的界面。
代码结构
整个项目位于FlutterCookbook这个仓库中,如果大家想使用的话,可以fork一份到自己的仓库中。
所有的示例代码都放在了lib目录下,文件名使用ex00X_XXX.dart
这样的格式,00x使用数字,而且逐渐递增,这相当于以顺序方式管理文件,数字后面是下划线,下划线后面是具体的文件名,文件名表示代码中的主要内容,比如ex001_button表示这个文件中的代码主题是button。如果大家不理解文件名的含义也不用担心,我会在README文件中给出详细说明。
代码中有一个main.dart
文件,这个是app程序的入口文件,这个文件中的代码只是为了管理app界面,与其它内容没有关系。
界面结构
启动App后先进入的界面是程序主界面,该界面中是一个list,可以通过滑动来查看不同的示例,这样设计是为了存放更多的示例。
list
中的每一条内容占据一行,每行中分两列,
- 第一列是数字,这个数字和文件名中的数字一致;
- 第二列是标题,表示代码的主要内容。
这个标题是一个蓝色背景+白色文字的Button,点击Button就可以跳转到示例程序所在的界面中。这个界面就是我们在博客中演示的程序运行效果界面,点击界面上面的返回键可以返回到主界面中。
总之,主界面是其它程序的入口,在主界面中通过点击Button可以跳转到其它示例程序的界面中。关于界面结构就介绍这些,后续如果有界面结构变化的话,我会通知大家。更多关于主界面的细节可以查看main.dart文件中的代码。
更新方式
示例代码的更新方式通过git管理,我会把本地项目中的代码push
到Github上的仓库中。提交的内容中会在commit中说明,不过这个说明是英文说明,更多细节上的东西只有通过代码才能看到。如果大家想看代码的差异,可以通过github的diff功能来查看。
经验总结
在最早写Talk C栗子
时代码就一个文件直接上传到了CSDN的附件中,后来写Talk Android
时也是没有做好的代码管理,到现在写Talk Flutter
时决定严格使用git来管理示例代码。这么做主要有以下几点原因:
- 博客中如果写出大量的代码,不太好看,如果写的太少会无法表达代码的含义。因此通过Github来管理代码,这里存放着完整的代码,在博客中只列出核心代码,这样可以通过核心代码说明程序原理,完整代码方便其它看官查看。
- 代码中包含着许多细节上的内容,过几个月就有可能忘记,这时再查看代码的提交记录就会明白其中的内容。可以看作是备忘录。
以上内容都是我在写作过程中总结出的经验,欢迎大家在评论区交流与讨论。