1 引言

Flutter

Flutter是由Google公司开发的的一款跨平台应用框架，其使用dart作为主要使用的编程语言。我们会基于Effective Dart中的相关规范，并结合Flutter框架以及具体的业务，指定详细的开发规范，使代码与产品变得更加健壮。

后续的代码规范主要分成三个部分：dart、flutter与业务。dart主要介绍与dart语言开发相关的规范，flutter主要介绍与flutter框架紧密相关的额外规范，而业务主要指业务相关项的规范需求。（例如嵌入式设备的接入等）

引言

类别

在代码规范中，我们会根据实际场景规定四种规范类别：

1. 强制：必须遵守的规范项，对应Effective Dart中的DO。
2. 禁止：禁止使用的规范项，对应Effective Dart中的DON'T。
3. 推荐：推荐使用的规范项，我们推荐你按照规范去编写代码，当你觉得其他的方式阅读性更强时，你可以不适用此规范项，对应Effective Dart中的PREFER。
4. 避免：应当避免使用的规范项，虽然有少数情况下存在使用避免规范项的场景，对应Effective Dart中的AVOID。

代码规范的制定有利于保证风格一致性的代码，也能够有效规避代码阅读性差、难以维护的弊端。

思想

代码的规范并不是为了约束，而是为了更好的可读性，而可读性应当以清晰、简洁、统一作为主要目标。清晰主要指代码应当具有一定的自释义性，即代码本身就能表达变量、函数等的功能；简洁主要指应当使用尽量简洁的语句去描述代码，擅长使用缩写去简化过长的单词；而统一主要指应用的各块功能、各个代码片段应当是协调的，风格也应当尽量的统一。该代码规范尽量遵循官方的代码规范，尽量避免风格化的规范需求。

展望

代码规范不是一蹴而就的，它会根据实际项目的变化、以及框架与语言的变化做出一定的适应与调整，也需要根据项目的进行做出一定的补充与修改，但总体而言，应当遵循一贯的原则。第一版的开发规范主要就代码的风格、项目结构以及框架的选用进行了约束。

第一版大致内容：

• 代码风格、命名以及注释。
• 项目结构。
• 框架或者插件的选用。
• 其他。