dart effective-风格和文档

一、dart风格

1.大小写

UpperCamelCase  每个单词首字母大写

lowerCamelCase 第一个单词的首字母小写

lowercase_with_underscores 全部小写，字母使用下划线分割

 

（1）类、枚举类型、typedef和类型参数应使用 UpperCamelCase

 

（2）扩展方法使用 UpperCamelCase

 

（3）库名、包名、目录、源文件使用lowercase_with_underscores

 

（4）导入的as使用 lowercase_with_underscores

import 'package:angular_components/angular_components' as angular_components;

（5）常量优先使用

const defaultTimeout = 1000;
final urlScheme = RegExp('^([a-z]+):');

 

（6）类成员、顶级函数、变量、参数、命名参数使用lowerCamelCase

 

2.顺序

导入时的顺序

（1）dart自带库放最前面

import 'dart:async';
import 'dart:html';

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

（2）绝对导入放在相对导入之前

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

import 'util.dart';

（3）export放在最后面

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

export 'src/error.dart';

（4）按字母顺序排序

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

import 'foo.dart';
import 'foo/foo.dart';

 

3.格式化

（1）使用dartfmt格式化代码

（2）一个不要超过80个字符

（3）不是所有的if语句都要使用花括号

if (arg == null) return defaultValue;

如果不在一行，要使用括号

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

 

二、文档

1.注释

 双斜杠 // 注释的说明，不会进入注释文档中

 

2.文档注释

文档注释会使用 dartdoc 解析并生成漂亮的文档

/// 或者 /** */

 

3.Markdown

可以在注释中使用markdown格式

避免过度使用markdown

避免在markdown中使用html

反引号表示代码

/// You can use [CodeBlockExample] like this:
///
/// ```
/// var example = CodeBlockExample();
/// print(example.isItGreat); // "Yes."
/// ```

 

4.写作

 涉及英语的写作规范，略