首页 > 其他分享 >dart effective-风格和文档

dart effective-风格和文档

时间:2022-12-08 15:37:59浏览次数:43  
标签:bar effective package dart 文档 使用 import foo

一、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.写作

 涉及英语的写作规范,略



标签:bar,effective,package,dart,文档,使用,import,foo
From: https://blog.51cto.com/u_13854953/5922259

相关文章

  • dart effective-设计
    1.命名对同一个事物使用相同的名称表示 除非缩写比未缩写的术语更加普遍,否则不要用缩写 优先把描述性强的词语方法最后pageCountbuildRectanglesIOStreamHttpRequest考虑......
  • dart 库
    导入库导入内置库import'dart:html';  拆分成多个库 a.dartpartof"./sum.dart";classA{staticinta=10;}b.dartpartof"./sum.dart";classB{staticintb......
  • dart Metadata-元数据
    相当于java里的注解,C#里的特性, Metadatelibrarytodo;classTodo{finalStringwho;finalStringwhat;constTodo(this.who,this.what);} @Todo('seth','maket......
  • dart Typedefs
    目前Typedefs只能赋值函数,未来可能有其他类型//定义一个别名typedefFu=intFunction(inta,intb);classA{//生命一个别名类型Fuf;A(this.f);}main(List<Strin......
  • 用pageOffice控件实现 office word文档在线另存为pdf的功能
    用pageOffice控件实现officeword文档在线另存为pdf的功能1应用场景OA办公中,经常要将word文档转存为pdf方法,方式文档的查看。怎么实现word文档的转存为pdf呢?2实现方......
  • 如何通过C#合并Word文档?
    合并Word文档可以快速地将多份编辑好的文档合在一起,避免复制粘贴时遗漏内容,以及耗费不必要的时间,同时,也方便了人们阅读或者对其进行再次修改。例如,在我们进行团队作业的时......
  • 【开源库推荐】#4 Poi-办公文档处理库
    原文:【开源库推荐】#4Poi-办公文档处理库-Stars-One的杂货小窝github仓库apache/poiApachePOI是Apache软件基金会的开放源码函式库,POI提供API给Java程序对Microso......
  • 多模态文档LayoutLM版面智能理解技术演进-纪传俊
    多模态算法兴起的背景办公文档是各行各业最基础也是最重要的信息载体,不管是金融、政务、制造业、零售行业等等,各种类型的文档都是业务流转过程中必不可少的数字资料。以银行......
  • 多模态文档LayoutLM版面智能理解技术演进-纪传俊
    多模态算法兴起的背景办公文档是各行各业最基础也是最重要的信息载体,不管是金融、政务、制造业、零售行业等等,各种类型的文档都是业务流转过程中必不可少的数字资料。以银行......
  • 注释文档的生成
     生成注释文档:1、进入代码文件所在目录路径: 2、听课时讲师写的是python3,但是我的环境python3出不来,用python就可以。#1.查看注释文档的帮助文档python-mpydoc......