Flutter/Dart代码规范

flutter/dart.png
  1. 文件名: 小写+下划线

  2. 类型名(类名,函数类型名):大写开头驼峰

  3. 变量名(包含const final 常量):使用小写开头驼峰, 项目有特殊要求 const可以使用大写+下划线的方式,如同java中一样

  4. 超过两位的英文缩写一律按该单词为普通小写单词处理,使用小写

  5. 导包有顺序要求,且每"部分"间空行分隔开,每部分内按字母排序,按如下顺序排序
    dart sdk内的库
    flutter内的库
    第三方库
    自己的库
    相对路径引用

  6. 先全部import再export,不要交替进行

  7. 不使用new创建

  8. 组件,建议封装

  9. 函数体代码不宜过多,最好在20 - 30行以内 过多改用调用 一个方法中尽量只做一件事

  10. flutter嵌套层数最好3以内 改为调用

  11. 函数体写注释 文件内模块用mark 标注

  12. 单一组件和设置其属性 要写在一起 不要多个换行

  13. 入参过多,建议封类型

  14. 注释规范

  15. 模块过多建文件夹

  16. 加下划线代表private

  17. 函数参数定义要写参数类型

  18. if 格式定死 条件判断请写好注释 不要嵌套太多的逻辑判断 不能超过3层

if (true) {
    // aa
} else {
    // bb
}

18.函数示例

public
void printName(String name) {
    print("printName:" + name);
}
private
void _printName(String name) {
    print("_printName:" + name);
}

推荐阅读更多精彩内容