kotlin 编码规范

Kotlin编码规范
源代码组织
【强制】kotlin源文件命名必须使用首字母大写的驼峰风格
【强制】在实现一个接口时,实现成员的顺序应该与该接口的成员顺序相同
【强制】在类中总是将重载放在一起
【建议】避免在文件名中使用诸如“Util”之类的无意义词语
【建议】在源文件保持合理大小条件下鼓励多个声明语义上彼此紧密关联(类、顶级函数或者属性)放在同一个 Kotlin 源文件中
命名规则
【强制】包的名称总是小写且不使用下划线
【强制】类与对象的名称以大写字母开头并使用驼峰风格
【强制】函数、属性与局部变量的名称以小写字母开头、使用驼峰风格而不使用下划线,创建类实例的工厂函数除外,工厂函数可以与要创建的类具有相同的名称
【强制】常量名称(标有const 的属性,或者保存不可变数据的没有自定义 get 函数的顶层/对象 val属性)应该使用大写、下划线分隔的名称
【建议】不鼓励使用多个词的名称,但是如果确实需要使用多个词,可以将它们连接在一起或使用驼峰风格
【建议】如果一个类有两个概念上相同的属性,一个是公共 API 的一部分,另一个是实现细节,那么使用下划线作为私有属性名称的前缀
【建议】类的名称通常是用来解释类是什么的名词或者名词短语
【建议】方法的名称通常是动词或动词短语,说明该方法做什么
【建议】名称应该表明实体的目的是什么,所以最好避免在名称中使用无意义的单词
【建议】当使用首字母缩写作为名称的一部分时,如果缩写由两个字母组成,就将其大写(IOStream);而如果缩写更长一些,就只大写其首字母(XmlFormatter、 HttpInputStream)
格式化
【强制】使用 4 个空格缩进。不要使用 tab

你可能感兴趣的:(kotlin)