一、命名

1、駝峰命名法

• 大駝峰
  使用場(chǎng)景：類(lèi)、類(lèi)型、枚舉等，例：

Class UserModel {
}

enum Style {
}

• 小駝峰
  使用場(chǎng)景：變量、常量、實(shí)例化對(duì)象等，例:

var item;
bool isUser;
const userName;
final userInfo;  
List photoList；
HttpRequest httpRequest = new HttpRequest ( );

2、英文小寫(xiě)

使用場(chǎng)景: 文件夾名，例：

widgets//相關(guān)控件文件放在此目錄下；
model//相關(guān)模型文件
resourse//資源數(shù)據(jù)文件
utils//工具類(lèi)文件

3、英文小寫(xiě)+下劃線

使用場(chǎng)景：庫(kù)、源文件、文件名，例：

import ‘package:image_picker/image_picker.dart’;
image_picker.dart
home_page.dart//主頁(yè)面文件名
button_widget.dart//按鈕控件文件名

4、英文大寫(xiě)+下劃線

使用場(chǎng)景: 配置文件中的關(guān)鍵字key，例：

static const USER_NAME_KEY
static const BASE_URL

5、不使用前綴字母

Dart可以告訴你聲明的類(lèi)型、范圍、可變性等，例：

//推薦 
defaultTimeout

//不推薦 
kDefaultTimeout

二、排序

1、引入庫(kù)

在引入其他庫(kù)之前先引入所需要的Dart庫(kù)

import ‘dart:async’;

import ‘packet:test/test.dart’;

2、引入順序

Dart SDK內(nèi)的庫(kù)
Flutter內(nèi)的庫(kù)
第三方庫(kù)
自己的庫(kù)
相對(duì)路徑引用

注意每個(gè)部分使用空行分隔，例如：

import ‘dart:async’;

import ‘packet:flutter/material.dart;

import ‘packet:third_party/third_party.dart;

import ‘packet:my_packet/my.dart;
import ‘packet:my_packet/my.dart;

import ‘../model/my_model.dart’;

三、注釋

1、雙斜線

使用場(chǎng)景：基本上所有的變量、實(shí)例和函數(shù)方法，例：

double longitude;//經(jīng)度
String name;//名稱(chēng)

//登錄請(qǐng)求
loginRequest() {
}

2、Doc注釋

使用三斜線 /// 文檔注釋來(lái)記錄成員和類(lèi)型，例：

• 不含參

///刪除
void delete (){
}

• 含參，第一個(gè)句子之后添加一個(gè)空行，分成段落：

///刪除方法
///
///相關(guān)描述...
void delete(String path){
}

四、其它

1、變量

Dart中，未顯式初始化的變量或字段自動(dòng)被初始化為null，不需要多余賦值null。例：

//推薦 
int userId;

//不推薦 
int userId = null；

2、添加下劃線代表私有

私有變量、私有方法等，函數(shù)示例：

//public
void printName(String name ){
  print(“name = $name”);
}

//private
void _printName(String name ){
  print(“_name = $name”);
}

3、網(wǎng)絡(luò)請(qǐng)求中的Map集合參數(shù)應(yīng)該盡量以冒號(hào):對(duì)齊

  Response response = await dio.post(path, 
                               data:{"key":"value",
                                     "key":"value",
                                     "key":"value",
                                     "key":"value"});

4、不要使用new關(guān)鍵字

Dart2使new關(guān)鍵字可選，例：

//推薦
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!'),
    ],
  );
}

5、不要使用.length查看集合是否為空

.length只是為了查看集合中是否包含任何內(nèi)容，它的速度可能會(huì)非常慢?？梢允褂?isEmpty和.isNotEmpty，例：

//推薦
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(' ');

五、參考

官方文檔 Effective Dart
Style
Documentation
Usage
Design