前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >如何编写高质量的flutter代码

如何编写高质量的flutter代码

作者头像
用户1974410
发布2022-09-20 16:45:31
1.2K0
发布2022-09-20 16:45:31
举报
文章被收录于专栏:flutter开发精选

如何制定规则

编写高质量代码是困难的。特别说明一下,简单的演示 API 用法或展示 UI ,这个是很简单的。难的是,我们如何让自己的代码对其他开发人员有吸引力,让他们对你的代码库进行贡献。下面我们从一下几方面进行探讨。

开始写代码前,我们需要做的第一件事就是添加一个README。README的内容应该包含以下内容:首先,写清楚代码库是做什么的,以帮助其他开发者快速理解你的代码库。其次,要写清楚代码库的使用说明,以及提bug和建议的方式。

接下来,就是代码本身的控制了。如代码是否遵循开发规范?这个问题可以设置的很简单,也可以把linters设置的很严格。我喜欢在代码格式、布局和 linting 规则方面采用严格标准的规范。这些标准可以使得代码风格一致,使其更易于维护。在 Dart 和 Flutter 强制执行统一的代码格式,您可以将以下命令添加到 jerkins等CI中,如果代码格式不正确,则构建失败:

代码语言:javascript
复制
$ dart format --output none --set-exit-if-changed .

代码格式化后,下一步是强制执行lint。对于 Dart,我强烈建议使用lints包,对于 Flutter 我推荐flutter_lints包。要确保 lint 在 CI 中通过,要以下命令:

代码语言:javascript
复制
$ dart analyze

最后就是测试了。在flutter中有单元测试、集成测试,还有 Widget 测试。测试非常重要,测试能帮助我们说明清楚代码的使用方式和意图。当与上述 指令 结合使用时,这些测试还可以保持代码库的质量。可以通过如何测试 Flutter 应用程序代码了解有关 Flutter 测试功能的更多信息。Dart 和 Flutter 的 运行测试的命令分别为:

代码语言:javascript
复制
$ flutter test   # for Flutter projects
$ dart test      # for pure Dart projects

如何在GitHub上设置

如果代码库托管在 GitHub 上, Dart 项目,我建议使用Dart Setup进行设置,如果是Flutter项目,我建议使用Flutter Action。

覆盖率问题,请考虑“好的覆盖率”操作以保持较高的测试覆盖率。

最后可以使用添加工作流状态来管理您的 CI 状态。

希望信息可以帮助你是你的目标受众获得更多价值。

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-11-08,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 flutter开发精选 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 如何制定规则
  • 如何在GitHub上设置
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档