英文文档翻译--Kotlin(三、编码习惯)

编码习惯

Kotlin 的语言编码风格

命名风格

命名风格默认和 Java 编码习惯一样,比如:

  • 命名使用驼峰风格(命名中避免出现 _ )
  • 类型以大写字母开头
  • 方法和变量以小写字母开头
  • 缩进使用4空格
  • 公共方法需要说明文档,在 Kotlin Doc 中有说明

冒号

在分隔两个类型时,冒号前面需要空格;在分隔实例和类型时冒号前面没有空格。

interface Foo<out T : Any> : Bar {
    fun foo(a: Int): T
}

匿名函数

在匿名函数中,大括号两边需要留有空格,同样的,分隔参数和函数体的箭头两边也需要留有空格。可以的话,匿名函数外层需要用圆括号包裹。

list.filter { it > 10 }.map { element -> element * 2 }

在匿名函数中,短的非嵌套的表达式推荐使用it习惯用法,而不用声明参数。在嵌套的表达式中,必须声明参数。

函数头格式

只有几个参数的 class 可以写在一行里。

class Person(id: Int, name: String)

Class头比较长的时候,需要格式化,每一个主要的构造参数需要单独缩进一行。闭括号也需要单独一行。如果使用了继承,父类的构造器调用或者接口的实现需要和圆括号放在同一行:

class Person(
    id: Int, 
    name: String,
    surname: String
) : Human(id, name) {
    // ...
}

有多个接口时,父类的构造器调用需要写在第一行,每个接口需要换行:

class Person(
    id: Int, 
    name: String,
    surname: String
) : Human(id, name),
    KotlinMaker {
    // ...
}

构造器参数可以使用固定的缩进,或者延迟的缩进(固定缩进的两倍)

Unit类型

如果函数返回的是Unit,返回的需要省略返回类型:

fun foo() { // ": Unit" 在这里需要被省略

}

函数和属性

当函数没有参数的时候,可能可以被替换为只读属性。尽管语义是相似的,因为语言风格的原因使用后者而不是前者。
在遇见一下情况是更倾向于使用属性而不是函数:

  • 没有抛出异常的操作
  • 复杂度为 O(1)
  • 计算量小 (或者在第一次运行后有缓存)
  • 调用后返回相同的结果

生词表

单词 含义
convention n.1.集会;(正式)会议,(定期)大会;2.(美国)全国代表大会;政党代表大会;3.协议,公约;契约,合同;4.习惯,习俗,社会习俗
underscore vt. 强调;划线于…下;n. 底线,[计] 下划线
indentation 缩进
colon 冒号
Lambdas 匿名函数
brace n. 支柱;[语] 大括号;曲柄
parenthese n. 括号;圆括号
inheritance n. 继承;遗传;遗产
interchangeable adj. 可互换的;可交换的;可交替的

原文链接

http://kotlinlang.org/docs/reference/coding-conventions.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,636评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,890评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,680评论 0 330
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,766评论 1 271
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,665评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,045评论 1 276
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,515评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,182评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,334评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,274评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,319评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,002评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,599评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,675评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,917评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,309评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,885评论 2 341

推荐阅读更多精彩内容