Kotlin编码约定

译自《Coding Conventions》

该页面包含Kotlin语言的当前编码风格。

命名风格

如果有疑问,请默认使用Java编码约定,例如:

  • 使用camelCase方式命名(并避免在名称中使用下划线)
  • 类型以大写开始
  • 方法和属性从小写开始
  • 使用4空格缩进
  • 公共函数应该有文档,使其出现在Kotlin Doc中

冒号之前的空格

当冒号分隔了类型和超类型(type and supertype)时,冒号之前有一个空格;而当冒号分隔实例和类型(instance and type)时,冒号之前没有空格:

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

Lambda表达式

在lambda表达式中,大括号周围应该使用空格,且将参数与正文分开的箭头周围也应该有空格。 只要有可能,一个lambda表达式应该被传递到括号之外(passed outside of parentheses)。

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

在短而不嵌套的lambda中,建议使用it惯例,而不是明确声明参数。 在具有参数的嵌套lambda中,参数应始终明确地声明。

类头格式化(Class header formatting)

有几个参数的类可以写成一行:

class Person(id: Int, name: String)

具有较长类头的类应格式化,以使每个主构造函数参数在单独的行缩进。 此外,右括号应该在新的一行。 如果我们使用继承,则超类构造函数的调用(superclass constructor call)或实现的接口列表应位于与右括号相同的行上:

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

对于多个接口,超类构造函数的调用(superclass constructor call)应首先定位,然后每个接口应位于不同的行中:

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

构造函数参数可以使用常规缩进或连续缩进(双倍的常规缩进)。

Unit

如果函数返回Unit,则返回类型应该省略:

fun foo() { // ": Unit" is omitted here

}

函数与属性(Functions vs Properties)

在某些情况下,没有参数的函数可能与只读属性可互换(interchangeable )。 虽然语义是相似的,但是有一些风格约定(stylistic conventions),决定什么时候更偏向某一个。

当底层算法(underlying algorithm)满足如下条件时,属性优先于函数:

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

推荐阅读更多精彩内容