代码风格和规范

标识符

UpperCamelCase 每个单词的首字母都大写,包含第一个单词。

  • Classes(类名)、 enums(枚举类型)、 typedefs(类型定义)、以及 type parameters(类型参数)应该把每个单词的首字母都大写(包含第一个单词),不使用分隔符。
    与类型命名一样,扩展 (extension)的名称也应大写每个单词的首字母(包括第一个单词),并且不使用分隔符。
class SliderMenu { ... }
typedef Predicate = bool Function(T value);
extension MyFancyList on List { ... }

lowercase_with_underscores 只是用小写字母单词,即使是缩略词,并且单词之间使用 _ 连接。

  • 在库,package,文件夹,源文件 中使用 lowercase_with_underscores 方式命名。
    一些文件系统不区分大小写,所以很多项目要求文件名必须是小写字母。使用分隔符这种形式可以保证命名的可读性。使用下划线作为分隔符可确保名称仍然是有效的Dart标识符,如果语言后续支持符号导入,这将会起到非常大的帮助。
library peg_parser.source_scanner;

import 'file_system.dart';
import 'slider_menu.dart';
  • 用 lowercase_with_underscores 风格命名库和源文件名
import 'dart:math' as math;
import 'package:angular_components/angular_components'
    as angular_components;
import 'package:js/js.dart' as js;

lowerCamelCase 除了第一个字母始终是小写(即使是缩略词),每个单词的首字母都大写。

类成员、顶级定义、变量、常量,包括枚举的值,参数以及命名参数等 除了第一个单词,每个单词首字母都应大写,并且不使用分隔符。

var count = 3;

HttpRequest httpRequest;

void align(bool clearItems) {
  // ...
}
const pi = 3.14;
const defaultTimeout = 1000;
final urlScheme = RegExp('^([a-z]+):');

class Dice {
  static final numberGenerator = Random();
}
  • 把超过两个字母的首字母大写缩略词和缩写词当做一般单词来对待

首字母大写缩略词比较难阅读,特别是多个缩略词连载一起的时候会引起歧义。例如,一个以 HTTPSFTP 开头的名字,没有办法判断它是指 HTTPS FTP 还是 HTTP SFTP。
为了避免上面的情况,缩略词和缩写词要像普通单词一样首字母大写。
例外情况 两个字母情况下,类似 IO (input/output) 这样的 缩略词 要全大写。另外,两个字母的 缩写词 比如 ID (identification) 与其他常规单词一样,首字母大写即可: Id。

class HttpConnection {}
class DBIOPort {}
class TVVcr {}
class MrRogers {}

var httpRequest = ...
var uiHandler = ...
var userId = ...
Id id;
  • 不要使用前缀字母
defaultTimeout //对的
kDefaultTimeout  //错误写法

顺序

为了使文件前面部分保持整洁,每个“部分”应该使用空行分割。

  • 要 把 “dart:” 导入语句放到其他导入语句之前。
import 'dart:async';
import 'dart:html';

import 'package:bar/bar.dart';
import 'package:foo/foo.dart';
  • 要 把 “package:” 导入语句放到项目相关导入语句之前
import 'package:bar/bar.dart';
import 'package:foo/foo.dart';

import 'util.dart';
  • 要 把导出(export)语句作为一个单独的部分放到所有导入语句之后
import 'src/error.dart';
import 'src/foo_bar.dart';

export 'src/error.dart';

格式化

和其他大部分语言一样, Dart 忽略空格。 使用 dart format 格式化你的代码
Dart定义的格式化规则:Formatting Rules · dart-lang/dart_style Wiki

你可能感兴趣的:(代码风格和规范)