Flutter 代码规范

命名规范

1.文件名

由小写英文加下划线组成;如 custom_app_bar.darticon_user_image_default.jpg

2.类名

大驼峰法;如 CustomAppBar

2.函数名,变量名、参数名

小驼峰法;如 函数名: updateRenderObject() ; 变量名,参数名: userName ;

另外类的成员变量: 不推荐使用 m前缀(如mUserName),而是 userName

3.文件夹名(包名)

由小写英文或下划线组成;如文件夹名 home_page

Widget开发规范

1. 将每个Widget的定义整理到单独的函数里,达到UI页面代码清晰

2. 将复杂的Widget进行封装

3. 封装单个Widget,方便复用

4. Widget build方法:在 build 方法里尽量用最少的代码实现整体视图

可以把复杂的widget代码放到一个或多个方法中。

代码规范

  • if else使用大括号,尽可能不省略;

  • 不推荐使用new来实例对象(dart 旧版本语法);

  • page页面中(StatelessWidget、StatefulWidget)尽量将每一层和每一个widget以单独函数形式调用,层次清晰分明(工具类封装的Widget可例外);

  • 封装简单常用的widget,注意使用@required、assert对参数进行限定,判断;

  • 常用的颜色值和宽高值,使用统一相同含义值来赋值;

  • 实时处理报错(error)和警告(warning):Dart Analysis统计了所有报错和警告的具体信息;(好处:一则让代码程序更健壮,二则在dart sdk升级后,可避免报错);

  • 必要的简要的代码注释(不止是.dart文件,还包括pubspec.yaml);

  • 编码过程中习惯性使用“Reformat Code with dartfmt”;

  • 拒绝弱命名(如var a),拒绝硬编码(如if (a == 2)...);

  • 善用///[],"[]"内可以是类名、变量名,在引用中可以添加注释说明;

  • 适当的换行,函数体之间、语句过长等;

其他

  • 尽量不使用第三方插件库(SDK),大多数SDK在功能点覆盖和适配方面存在很多的缺陷;逼不得已时选择flutter官方指定维护的sdk、知名度和活跃度高的sdk;Flutter Favorite packages

  • 创建项目时,包名采用反写域名命名规则,即com.xx.xxx.xxxx形式全部使用小写字母。一级包名为com,二级包名为xx(一般为公司或个人域名),三级包名根据应用进行命名,四级包名为功能模块名;

  • 如果一个bool类型"isShow"在不确定是否会为null的情况下(尤其在与原生双向交互中),避免"if(isShow)..."这种写法,正确写法"if(isShow == true)";

  • 注重dispose()方法中资源的释放;

  • 删除或注释掉assets下无效的资源及pubspec.yaml的声明

高效 Dart 语言指南

https://dart.cn/guides/language/effective-dart

参考

Flutter的开发规范
Flutter开发规范

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,313评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,369评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,916评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,333评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,425评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,481评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,491评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,268评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,719评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,004评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,179评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,832评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,510评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,153评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,402评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,045评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,071评论 2 352

推荐阅读更多精彩内容

  • 前言 没有规矩,不成方圆。不管我们在写什么程序时,都需要对我们的代码进行规范处理。比如我们的css规范,html规...
    长情G阅读 2,751评论 0 2
  • 命名规范 命名规范中包括了文件以及文件夹的命名规范,常量和变量的命名规范,类的命令规范。Dart 中只包含这三种命...
    iVikings阅读 1,789评论 0 3
  • 起源 做为跨平台的移动端解决方案,Flutter大大提高了移动端的开发效率,但是由于很多开发者都是从原来做原生的i...
    huangjun0阅读 1,840评论 0 3
  • Dart 语法简介 Flutter是使用Dart语言开发的。Dart语言是基于类的纯面向对象语言。Dart 中的所...
    Cheney2006阅读 604评论 0 1
  • 一、开发工具,SDK版本要求 1、flutter可以说是Google的亲儿子,强烈推荐使用Android Stud...
    buhuiming阅读 3,224评论 2 7