代码风格和规范

2022-02-14  本文已影响0人  初见soulmate

标识符

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

class SliderMenu { ... }
typedef Predicate<T> = bool Function(T value);
extension MyFancyList<T> on List<T> { ... }

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

library peg_parser.source_scanner;

import 'file_system.dart';
import 'slider_menu.dart';
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  //错误写法

顺序

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

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 'src/error.dart';
import 'src/foo_bar.dart';

export 'src/error.dart';

格式化

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

上一篇 下一篇

猜你喜欢

热点阅读