• 首页
  • 感性生活,理性思考。


Flutter 命名规范

命名规范

AaBb 类规范

首字母大写驼峰命名法 , 例如IsClassName 常用语类名字

aaBb

首字母小写驼峰命名法 ,如isParameterName 常用语常量和变量命名

aa_bb

小写字母下划线连结法 例如 is_a_flutter_file_name 常用于文件及文件夹命名

注释

单行注视

// 与其它语言注释规范一致,

主要用于注释对于单行代码逻辑进行注释,为了避免过多注释

主要是在一些理解较为复杂的代码逻辑上进行注释

多行注释

一种是 ///
另一种是 / ....../

这俩种都可以使用,在dart推荐使用 ///
一般用于注释类和方法

///APP首页入口
///
///本模块函数,加载状态类组件HomePageState
class HomePage extends StatefulWidget {
  @override
  createState()=>new HomePageState();
}

///首页有状态组件类
///
///主要是获取当前啊时间,并动态展示当前时间
class HomePageState extends State<HomePage> {
  ///获取当前时间戳
  ///
  ///[prefix]需要传入一个前缀信息
  ///返回一个字符串类型的前缀信息: 时间戳
  getCurrentTime(String prefix){}
  
  ///有状态返回组件信息
  @override
  Widget build(BuildContext context){}
}

文档工具

将注释形成文档, 使用dart SDK里的命令dartdoc
NOTE:这个命令需要在环境变量里配置dart SDK路径

dartdoc

执行完以后,会在项目当前目录生成一个doc文件夹, 里边有一个api目录下的index.html

库引入规范

dart为了保持代码整洁, 规范了import库的顺序。将import库分了几个部分

每个部分用空行分割

  • dart库
  • package库
  • 其它未带协议头的的库

其次是相同部分按照模块的首字母顺序来排列

import 'dart:developer';
 
import 'package:flutter/material.dart';
import 'package:two_you_friend/pages/home_page.dart';

import 'util.dart';

代码美化

  • 使用空格而不是tab
  • 在一个完整的代码逻辑后面使用空行区分
  • 二元或者三元运算符之间使用空格
  • 在关键词,和;之后使用空格
  • 一元运算符后请勿使用空格
  • 在流程控制关键词, 例如for和while后,使用空格区分
  • 在([{}])符号后请勿使用空格
  • 在{ 后使用空格
  • 在 .操作符,从第二个.符号后每次都使用新的一行

本文链接:

https://chao.asia/tech/154.html

1 + 4 =
快来做第一个评论的人吧~
lamu.png