Flutter 代码开发规范

栏目: IOS · Android · 发布时间: 5年前

内容简介:Flutter 代码开发规范文档 仅做参考

Flutter 代码开发规范

Flutter 代码开发规范文档 仅做参考

标识符三种类型

大驼峰

类、枚举、typedef和类型参数

class SliderMenu { ... }
          
    class HttpRequest { ... }
          
    typedef Predicate = bool Function<T>(T value);

包括用于元数据注释的类

class Foo {
        const Foo([arg]);
      }
      
      @Foo(anArg)
      class A { ... }
      
      @Foo()
      class B { ... }

使用小写加下划线来命名库和源文件

library peg_parser.source_scanner;
      
    import 'file_system.dart';
    import 'slider_menu.dart';

不推荐如下写法:

library pegparser.SourceScanner;
    import 'file-system.dart';
    import 'SliderMenu.dart';

使用小写加下划线来命名导入前缀

import 'dart:math' as math;
    import 'package:angular_components/angular_components'
          as angular_components;
    import 'package:js/js.dart' as js;

不推荐如下写法:

import 'dart:math' as Math;
    import 'package:angular_components/angular_components'
      as angularComponents;
    import 'package:js/js.dart' as JS;

使用小驼峰法命名其他标识符

var item;
      
     HttpRequest httpRequest;
      
     void align(bool clearItems) {
        // ...
     }

优先使用小驼峰法作为常量命名

const pi = 3.14;
    const defaultTimeout = 1000;
    final urlScheme = RegExp('^([a-z]+):');
      
    class Dice {
        static final numberGenerator = Random();
    }

不推荐如下写法:

const PI = 3.14;
    const DefaultTimeout = 1000;
    final URL_SCHEME = RegExp('^([a-z]+):');
      
    class Dice {
      static final NUMBER_GENERATOR = Random();
    }

不使用前缀字母

因为Dart可以告诉您声明的类型、范围、可变性和其他属性,所以没有理由将这些属性编码为标识符名称。

defaultTimeout

不推荐如下写法:

kDefaultTimeout

排序

为了使你的文件前言保持整洁,我们有规定的命令,指示应该出现在其中。每个“部分”应该用空行分隔。

在其他引入之前引入所需的dart库

import 'dart:async';
    import 'dart:html';
      
    import 'package:bar/bar.dart';
    import 'package:foo/foo.dart';

在相对引入之前先引入在包中的库

import 'package:bar/bar.dart';
    import 'package:foo/foo.dart';
      
    import 'util.dart';

第三方包的导入先于其他包

import 'package:bar/bar.dart';
    import 'package:foo/foo.dart';
      
    import 'package:my_package/util.dart';

在所有导入之后,在单独的部分中指定导出

import 'src/error.dart';
    import 'src/foo_bar.dart';
      
    export 'src/error.dart';

不推荐如下写法:

import 'src/error.dart';
    export 'src/error.dart';
    import 'src/foo_bar.dart';

所有流控制结构,请使用大括号

这样做可以避免悬浮的else问题

if (isWeekDay) {
        print('Bike to work!');
    } else {
        print('Go dancing or read a book!');
    }

一个if语句没有else子句,其中整个if语句和then主体都适合一行。在这种情况下,如果你喜欢的话,你可以去掉大括号

if (arg == null) return defaultValue;

如果流程体超出了一行需要分划请使用大括号:

if (overflowChars != other.overflowChars) {
      return overflowChars < other.overflowChars;
    }

不推荐如下写法:

if (overflowChars != other.overflowChars)
        return overflowChars < other.overflowChars;

注释

要像句子一样格式化

除非是区分大小写的标识符,否则第一个单词要大写。以句号结尾(或“!”或“?”)。对于所有的注释都是如此:doc注释、内联内容,甚至TODOs。即使是一个句子片段。

greet(name) {
      // Assume we have a valid name.
      print('Hi, $name!');
    }

不推荐如下写法:

greet(name) {
      /* Assume we have a valid name. */
      print('Hi, $name!');
    }

可以使用块注释(/…/)临时注释掉一段代码,但是所有其他注释都应该使用//

Doc注释

使用///文档注释来记录成员和类型。

使用doc注释而不是常规注释,可以让dartdoc找到并生成文档。

/// The number of characters in this chunk when unsplit.
    int get length => ...

考虑为私有api编写文档注释

Doc注释并不仅仅针对库的公共API的外部使用者。它们还有助于理解从库的其他部分调用的私有成员

以简短的、以用户为中心的描述开始你的文档注释,以句号结尾。

/// Deletes the file at [path] from the file system.
    void delete(String path) {
      ...
    }

不推荐如下写法:

/// Depending on the state of the file system and the user's permissions,
    /// certain operations may or may not be possible. If there is no file at
    /// [path] or it can't be accessed, this function throws either [IOError]
    /// or [PermissionError], respectively. Otherwise, this deletes the file.
    void delete(String path) {
      ...
    }

字符串的使用

优先使用模板字符串

'Hello, $name! You are ${year - birth} years old.';

集合

尽可能使用集合字面量

如果要创建一个不可增长的列表,或者其他一些自定义集合类型,那么无论如何,都要使用构造函数。

var points = [];
    var addresses = {};
    var lines = <Lines>[];

不推荐如下写法:

var points = List();
    var addresses = Map();

不要使用.length查看集合是否为空

if (lunchBox.isEmpty) return 'so hungry...';
    if (words.isNotEmpty) return words.join(' ');

不推荐如下写法:

if (lunchBox.length == 0) return 'so hungry...';
    if (!words.isEmpty) return words.join(' ');

考虑使用高阶方法转换序列

如果有一个集合,并且希望从中生成一个新的修改后的集合,那么使用.map()、.where()和Iterable上的其他方便的方法通常更短,也更具有声明性

var aquaticNames = animals
          .where((animal) => animal.isAquatic)
          .map((animal) => animal.name);

避免使用带有函数字面量的Iterable.forEach()

在Dart中,如果你想遍历一个序列,惯用的方法是使用循环。

for (var person in people) {
      ...
    }

不推荐如下写法:

people.forEach((person) {
        ...
    });

不要使用List.from(),除非打算更改结果的类型

给定一个迭代,有两种明显的方法可以生成包含相同元素的新列表

var copy1 = iterable.toList();
    var copy2 = List.from(iterable);

明显的区别是第一个比较短。重要的区别是第一个保留了原始对象的类型参数

// Creates a List<int>:
    var iterable = [1, 2, 3];
    
    // Prints "List<int>":
    print(iterable.toList().runtimeType);
// Creates a List<int>:
    var iterable = [1, 2, 3];
    
    // Prints "List<dynamic>":
    print(List.from(iterable).runtimeType);

参数的使用

使用=将命名参数与其默认值分割开

由于遗留原因,Dart均允许“:”和“=”作为指定参数的默认值分隔符。为了与可选的位置参数保持一致,使用“=”。

void insert(Object item, {int at = 0}) { ... }

不推荐如下写法:

void insert(Object item, {int at: 0}) { ... }

如果参数是可选的,但没有给它一个默认值,则语言隐式地使用null作为默认值,因此不需要编写它

void error([String message]) {
      stderr.write(message ?? '\n');
    }

不推荐如下写法:

void error([String message = null]) {
      stderr.write(message ?? '\n');
    }

变量

不要显式地将变量初始化为空

在Dart中,未显式初始化的变量或字段自动被初始化为null。不要多余赋值null

int _nextId;
      
      class LazyId {
        int _id;
      
        int get id {
          if (_nextId == null) _nextId = 0;
          if (_id == null) _id = _nextId++;
      
          return _id;
        }
      }

不推荐如下写法:

int _nextId = null;
      
      class LazyId {
        int _id = null;
      
        int get id {
          if (_nextId == null) _nextId = 0;
          if (_id == null) _id = _nextId++;
      
          return _id;
        }
      }

避免储存你能计算的东西

在设计类时,您通常希望将多个视图公开到相同的底层状态。通常你会看到在构造函数中计算所有视图的代码,然后存储它们:

class Circle {
        num radius;
        num area;
        num circumference;
      
        Circle(num radius)
            : radius = radius,
              area = pi * radius * radius,
              circumference = pi * 2.0 * radius;
      }

如上代码问题:

浪费内存
缓存的问题是无效——如何知道何时缓存过期需要重新计算?

推荐的写法如下:

class Circle {
        num radius;
      
        Circle(this.radius);
      
        num get area => pi * radius * radius;
        num get circumference => pi * 2.0 * radius;
      }

类成员

不要把不必要地将字段包装在getter和setter中

不推荐如下写法:

class Box {
        var _contents;
        get contents => _contents;
        set contents(value) {
          _contents = value;
        }
      }

优先使用final字段来创建只读属性

尤其对于 StatelessWidget

在不需要的时候不要用this

不推荐如下写法:

class Box {
        var value;
        
        void clear() {
          this.update(null);
        }
        
        void update(value) {
          this.value = value;
        }
      }

推荐如下写法:

class Box {
        var value;
      
        void clear() {
          update(null);
        }
      
        void update(value) {
          this.value = value;
        }
      }

构造函数

尽可能使用初始化的形式

不推荐如下写法:

class Point {
        num x, y;
        Point(num x, num y) {
          this.x = x;
          this.y = y;
        }
      }

推荐如下写法:

class Point {
      num x, y;
      Point(this.x, this.y);
    }

不要使用new

Dart2使new 关键字可选

推荐写法:

Widget build(BuildContext context) {
        return Row(
          children: [
            RaisedButton(
              child: Text('Increment'),
            ),
            Text('Click!'),
          ],
        );
      }

不推荐如下写法:

Widget build(BuildContext context) {
        return new Row(
          children: [
            new RaisedButton(
              child: new Text('Increment'),
            ),
            new Text('Click!'),
          ],
        );
      }

异步

优先使用async/await代替原始的futures

async/await语法提高了可读性,允许你在异步代码中使用所有Dart控制流结构。

Future<int> countActivePlayers(String teamName) async {
        try {
          var team = await downloadTeam(teamName);
          if (team == null) return 0;
      
          var players = await team.roster;
          return players.where((player) => player.isActive).length;
        } catch (e) {
          log.error(e);
          return 0;
        }
    }

当异步没有任何用处时,不要使用它

如果可以在不改变函数行为的情况下省略异步,那么就这样做:

Future afterTwoThings(Future first, Future second) {
        return Future.wait([first, second]);
    }

不推荐写法:

Future afterTwoThings(Future first, Future second) async {
        return Future.wait([first, second]);
    }

以上就是本文的全部内容,希望本文的内容对大家的学习或者工作能带来一定的帮助,也希望大家多多支持 码农网

查看所有标签

猜你喜欢:

本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们

社交网站的数据挖掘与分析

社交网站的数据挖掘与分析

Matthew A. Russell / 师蓉 / 机械工业出版社 / 2012-2 / 59.00元

Facebook、Twitter和LinkedIn产生了大量宝贵的社交数据,但是你怎样才能找出谁通过社交媒介正在进行联系?他们在讨论些什么?或者他们在哪儿?这本简洁而且具有可操作性的书将揭示如何回答这些问题甚至更多的问题。你将学到如何组合社交网络数据、分析技术,如何通过可视化帮助你找到你一直在社交世界中寻找的内容,以及你闻所未闻的有用信息。 每个独立的章节介绍了在社交网络的不同领域挖掘数据的......一起来看看 《社交网站的数据挖掘与分析》 这本书的介绍吧!

URL 编码/解码
URL 编码/解码

URL 编码/解码

UNIX 时间戳转换
UNIX 时间戳转换

UNIX 时间戳转换