Dart代码风格
2019-11-06 本文已影响0人
SingleDigit
主要是记录一下官方要求的代码风格和自己目前习惯的(C#)代码风格的差异,并不完全。
&& 我一直认为代码风格重要的是统一方便而不是严格按照规范来。
官方代码风格地址 Effective Dart
- 命名
需要注意的就是文件命名,库命名,和导入库的前缀(别名)全部用 file_name 这种形式。
文章中推荐常量名也用 valueName 这种形式,但个人觉得区分不大容易混淆,还是使用 ConstValueName 的格式吧
- 导入库的排序(类似于C#中开头的using)
依次是:import:[ "dart:xxx", "package:xxx", "package:Myxxx" ], export "xxxx"
其中,每一块内容里按照字母顺序进行排序。
- 一些格式化的问题
- 使用dartfmt可以自动格式化代码
- 编辑器的tab可能需要额外设置一下,让它变成两个空格。
- 方法之类的第一个大括号跟在函数后面而不是另起一行。
- 其他的和一般语言基本没什么变化&&基本编辑器自动的格式化就能满足。
- 注释
文档注释直接用///
而不是像C#那种写成XML那种格式的,&&文档注释支持大部分markDown语法,dartdoc 可以直接格式化显示。