Flutter编码规范及工具使用
最近学习听课,讲师讲了下编码规范及相对应对检测工具讲解,及自己的理解在这里分享下。
命名规范
命名规范中包括了文件以及文件夹的命名规范,常量和变量的命名规范,类的命令规范。Dart 中只包含这三种命名标识。
AaBb 类规范,首字母大写驼峰命名法,例如 IsClassName,常用于类的命名。
aaBb 类规范,首字母小写驼峰命名法,例如 isParameterName,常用于常量以及变量命名。
aa_bb 类规范,小写字母下划线连接法,例如 is_a_flutter_file_name,常用于文件及文件夹命名。
注释规范
注释的目的是生成我们需要的文档,从而增强项目的可维护性。
单行注释
单行注释主要是“ // ”这类标示的注释方法,这类注释与其他各类语言使用的规范一致。单行注释主要对于单行代码逻辑进行解释,为了避免过多注释,主要是在一些理解较为复杂的代码逻辑上进行注释。
比如,下面这段代码没有注释,虽然你看上下文也会知道这里表示的是二元一次方程的 ∆ ,但是却不知道如果 ∆ 大于 0 ,为什么 x 会等于 2。
if ( b * b - 4 * a * c > 0 ) {x = 2;
}
如果加上注释则显得逻辑清晰容易理解,修改后如下所示。
// 当∆大于0则表示方程x个解,x则为2
if ( b * b - 4 * a * c > 0 ) {x = 2;
}
虽然单行注释大家都比较了解,但我这里还是多解释了下如何应用,主要是希望大家规范化使用,减少不必要的代码注释。
多行注释
在 Dart 中由于历史原因(前后对多行注释方式进行了修改)有两种注释方式,一种是 /// ,另外一种则是 / … / 或者 /…/ ,这两种都可以使用。/*…/ 和 /…*/ 这种块级注释方式在其他语言(比如 JavaScript )中是比较常用的,但是在 Dart 中我们更倾向于使用 /// ,后续我们所有的代码都按照这个规范来注释。
多行注释涉及类的注释和函数的注释。两者在注释方法上一致。首先是用一句话来解释该类或者函数的作用,其次使用空行将注释和详细注释进行分离,在空行后进行详细的说明。如果是类,在详细注释中,补充该类作用,其次应该介绍返回出去的对象功能,或者该类的核心方法。如果是函数,则在详细注释中,补充函数中的参数以及返回的数据对象。
假设有一个 App 首页的库文件,其中包含类 HomePage , HomePage 中包含两个方法,一个是 getCurrentTime ,另一个是 build 方法,代码注释如下(未实现其他部分代码)。
import 'package:flutter/material.dart';
/// APP 首页入口
///
/// 本模块函数,加载状态类组件HomePageState
class HomePage extends StatefulWidget {@overridecreateState() => new HomePageState();
}
/// 首页有状态组件类
///
/// 主要是获取当前时间,并动态展示当前时间
class HomePageState extends State<HomePage> {/// 获取当前时间戳////// [prefix]需要传入一个前缀信息/// 返回一个字符串类型的前缀信息:时间戳String getCurrentTime(String prefix) {}/// 有状态类返回组件信息@overrideWidget build(BuildContext context) {}
}
注释文档生成
根据上面的代码注释内容,我们利用一个官方工具来将当前项目中的注释转化为文档。
打开命令行工具进入当前项目,或者在 Android Studio 点击界面上的 Terminal 打开命令行窗口,运行如下命令。
dartdoc
运行结束后,会在当前项目目录生成一个 doc 的文件夹。
在生成文件夹中,可以直接打开 doc/api/index.html 文件。
以上是使用标准的代码注释生成的文档,利用这种方式将大大提升项目的可维护性,在项目初期就要做好此类规范。
库引入规范
Dart 为了保持代码的整洁,规范了 import 库的顺序。将 import 库分为了几个部分,每个部分使用空行分割。分为 dart 库、package 库和其他的未带协议头(例如下面中的 util.dart )的库。其次相同部分按照模块的首字母的顺序来排列,例如下面的代码示例:
import 'dart:developer';
import 'package:flutter/material.dart';
import 'package:two_you_friend/pages/home_page.dart';
import 'util.dart';
代码美化
在 Dart 中同样有和前端一样的工具 pritter ,在 Dart 中叫作 dartfmt ,该工具和 dartdoc 一样,已经包含在 Dart SDK 中,因此可以直接运行如下命令检查是否生效。
dartfmt -h
既然有此类工具,我们就来看下如何应用工具来规范和美化我们的代码结构。
dartfmt
dartfmt 工具的规范包括了以下几点:
使用空格而不是 tab;
在一个完整的代码逻辑后面使用空行区分;
二元或者三元运算符之间使用空格;
在关键词 , 和 ; 之后使用空格;
一元运算符后请勿使用空格;
在流控制关键词,例如 for 和 while 后,使用空格区分;
在 ( [ { } ] ) 符号后请勿使用空格;
在 { 后前使用空格;
使用 . 操作符,从第二个 . 符号后每次都使用新的一行。
其他规范可以参考 dartfmt 的官网。了解完以上规范后,我们现在将上面的 home_page.dart 进行修改,将部分代码修改为不按照上面规范的结构,代码修改如下:
import 'package:flutter/material.dart';
/// APP 首页入口
///
/// 本模块函数,加载状态类组件HomePageState
class HomePage extends StatefulWidget{@overridecreateState() => new HomePageState();
}
/// 首页有状态组件类
///
/// 主要是获取当前时间,并动态展示当前时间
class HomePageState extends State<HomePage> {/// 获取当前时间戳////// [prefix]需要传入一个前缀信息/// 返回一个字符串类型的前缀信息:时间戳String getCurrentTime( String prefix ) {}/// 有状态类返回组件信息@overrideWidget build(BuildContext context) {}
}
上面 getCurrentTime 的参数和 { 没有按照 dartfmt 规范来处理,在当前目录下打开 Terminal,然后先运行以下命令来修复当前的代码规范:
dartfmt -w --fix lib/
{ 前无空格问题,和 getCurrentTime 参数空格问题,会被修复,说白了就是格式化代码。
工具化
在 Dart 中同样存在和 eslint 一样的工具 dartanalyzer 来保证代码质量(但是只是静态的检测)。
该工具( dartanalyzer )已经集成在 Dart SDK ,你只需要在 Dart 项目根目录下新增analysis_options.yaml 文件,然后在文件中按照规范填写你需要执行的规则检查即可,目前现有的检查规则可以参考 Dart linter rules 规范。
为了方便,我们可以使用现成已经配置好的规范模版,这里有两个库 pedantic 和 effective_dart 可以参照使用。如果我们需要在项目中,使用它们两者之一,可以在项目配置文件( pubspec.yaml )中新增如下两行配置:
dependencies:flutter:sdk: flutterpedantic: ^1.9.2# The following adds the Cupertino Icons font to your application.# Use with the CupertinoIcons class for iOS style icons.cupertino_icons: ^0.1.2
dev_dependencies:flutter_test:sdk: flutterpedantic: ^1.9.2
配置完成以后,在当前项目路径下运行 flutter pub upgrade 。接下来在本地新增的 analysis_options.yaml 文件中新增如下配置:
include: package:pedantic/analysis_options.1.9.2.yaml
如果我们认为 pedantic 不满足我们的要求,我们再根据 Dart linter rules 规范,前往选择自己需要的规范配置,修改下面的配置:
include: package:pedantic/analysis_options.1.8.0.yaml
analyzer:strong-mode:implicit-casts: false
linter:rules:# STYLE- camel_case_types- camel_case_extensions- file_names- non_constant_identifier_names- constant_identifier_names # prefer- directives_ordering- lines_longer_than_80_chars # avoid# DOCUMENTATION- package_api_docs # prefer- public_member_api_docs # prefer
我在 pedantic 的基础上又增加了一些对于样式和文档的规范,增加完成以上配置后,运行如下命令可进行检查。
dartanalyzer lib
控制台输出
lint • Document all public members. • lib/platform_view.dart:8:7 • public_member_api_docs
意思就是:需要添加注释。
lint • AVOID lines longer than 80 characters. • lib/simple_page_widgets.dart:81:1 • lines_longer_than_80_chars
意思是:每行超过了80字符,因为我们的规范是80字符。
当然还会有其他问题,每个团队都有自己对应的规则,根据自己匹配的规则进行修改。
总结,我们需要记住基础规范及配置的规则和对应的命令。
基础规范:规定基础的代码规范。
dartdoc :对代码和注释输出文档,这个很方便,只要注释全,完全就是成品文档,所以最开始就要养成良好注释和编码习惯。
dartfmt -w --fix lib/:美化、格式化lib下代码。
dartanalyzer lib:根据编码规范规则进行检测修改lib下的代码规范。前提需要配置`pubspec.yaml `和添加`analysis_options.yaml `.
Flutter编码规范及工具使用相关推荐
- idea,配置checkstyle 【提高代码质量,检查代码规范的工具 】Checkstyle,FindBugs,PMD,Jtest
idea,配置checkstyle [提高代码质量,检查代码规范的工具 ]Checkstyle,FindBugs,PMD,Jtest 2016年12月15日 14:19:02 common_util ...
- Android开发之代码检测工具Lint和阿里巴巴编码规范扫描(代码检测工具)
我们写代码很多都不规范,如何检测? 实际上AS自带检测工具了叫lint如下图: 还有一款是阿里巴巴的代码检测和AS自带的差不多如下图: 下面我们来说下这两个如何使用呢? 1.我们先说AS系统自带的吧 ...
- Python最简编码规范
0.前言 本文是阅读<Python Coding Rule>之后总结的最为精华及简单的编码规范,根据每个人不同喜好有些地方会有不同的选择,我只是做了对自己来说最简单易行的选择,仅供大家参考 ...
- Go 语言编程 — 编码规范指南
目录 文章目录 目录 参考 工程化要求 编码规范 大小约定 缩进.括号和空格约定 命名规范 包.目录命名规范 文件命名规范 标识符命名规范 变量.常量名 函数.方法名 结构体.接口名 空行.注释.文档 ...
- 人人FED CSS编码规范
完整PDF下载链接:<人人FED CSS编码规范> 浏览器特效支持规范 为了页面性能考虑,如果浏览器不支持CSS3相关属性的,则该浏览器的某些特效将不再支持,属性的支持情况如下表所示: ...
- 【浙大网新图灵通讯】无废话简单高效C#编码规范20100611
无废话简单高效C#编码规范20100611 自己看自己的代码啥问题也没有,但是一个团队.N多个人.N多年的代码,就比较难维护.难阅读了,什么样的不好的习惯.错误漏洞能出来的就全出来了. 第1章 ...
- python编码规范手册-Python官方竟然给出了一种编码规范PEP 8
写在之前 每个人都有自己的代码风格,随着写的行数增加,自己对于代码的审美也会变的不一样,这就像是一个逐渐蜕变的过程,每过一段时间回头再去看看自己之前写的代码就会生出一种「这么丑的玩意儿竟然是我写的」这 ...
- python编码规范手册-PEP8 Python 编码规范整理
决定开始Python之路了,利用业余时间,争取更深入学习Python.编程语言不是艺术,而是工作或者说是工具,所以整理并遵循一套编码规范是十分必要的.所以今天下午我根据PEP 8整理了一份,以后都照此 ...
- JavaScript编码规范[百度]
JavaScript编码规范 1 前言 2 代码风格 2.1 文件 2.2 结构 2.2.1 缩进 2.2.2 空格 2.2.3 换行 2.2.4 语句 2.3 命名 2.4 注释 2.4.1 单行注 ...
最新文章
- python运行文件后缀_Python程序存储成以.py为扩展名的程序文件用Python解释器执行。(4.5分)_学小易找答案...
- 安装oracle11g client 【INS-30131】执行安装程序验证所需的初始设置失败的解决方法
- jpa连接mysql报错_Spring boot jpa mysql 连接数据库SSL错误
- WEB前端学习笔记01利用纯CSS书写二级水平导航菜单
- HALCON示例程序pcb_inspection.hdev检测pcb印刷缺陷
- mysql 打包 脚本_windows下mysql自动备份压缩打包时间命名批处理脚本
- 《时间序列分析及应用.R语言》第十一章阅读笔记
- 三校生计算机高考试卷及答案,云南三校生计算机专业课高考试卷3
- 网站地图在线生成html,如何制作网站地图(sitemap.html和sitemap.xml)?
- 计算机密码突然不正确,win10开机密码明明正确,win10密码突然不对了
- GPS 定位精度查看
- 老米之家 抢注域名应该怎么抢?抢注域名的价值如何去衡量
- MYIP网站信息状态条 (MyIP Status Bar for IE)——挑战极限,一秒钟评价一个网站!
- Graphics2D绘制图片,线段、矩形、圆形
- 计算机无线网卡连接网络,无线网络连接不稳定
- The Perfect Man (超完美男人)
- WebRTC技术详解
- 千里送人头 ——APIO2017 游记
- 内存在计算机中的作用及其性能参数有哪些,内存的性能指标有哪些 主要参数是什么...
- 2022,互联网大厂不太平
热门文章
- 【大数据开发运维解决方案】ssh: undefined symbol: EVP_KDF_ctrl, version OPENSSL_1_1_1b问题解决过程
- 认证失败: 不能认证到服务器: 被拒绝的 Basic 挑战
- 幻想-FLEX 3基础视频教程 持续更新中
- php中的帝国是什么意思,帝国cms有什么用
- web端输出打印地图(ArcGIS api for Javascript)一、地图打印模板的制作
- Android热修复学习之旅——HotFix完全解析
- trim函数实现php,php trim函数的详细解析
- P1_M1_L3 Driving Decisions and Actions(驾驶决策和行为)
- 如何在汽车行业运用IPD?
- 服务器1075错误服务修复,请教2012R2的系统 computer browser服务启动不起来提示错误1075 导致文件共享和连接网络硬盘都不行...