美文网首页
Kotlin 文件管理规范

Kotlin 文件管理规范

作者: WotYang | 来源:发表于2020-06-17 10:54 被阅读0次

文件名称

文件的名称应该描述文件中代码的作用,所以不要写无用词语。

  • 如果 Kotlin 文件包含单个类(以及可能相关的顶层声明),那么文件名应该与该类的名称相同,并追加 .kt 扩展名。
  • 如果文件包含多个类或只包含顶层声明, 那么选择一个描述该文件所包含内容的名称,并以此命名该文件。 使用首字母大写的驼峰风格(例如 ProcessDeclarations.kt)。

文件组织

建议多个声明(类、顶级函数或者属性)放在同一个 Kotlin 源文件中, 只要这些声明在语义上彼此紧密关联并且文件保持合理大小 (不超过几百行)。

特别是在为类定义与类的所有客户都相关的扩展函数时, 请将它们放在与类自身定义相同的地方。而在定义仅对指定客户有意义的扩展函数时,请将它们放在紧挨该客户代码之后。不要只是为了保存 “Foo 的所有扩展函数”而创建文件。


类布局

通常,一个类的内容按以下顺序排列:

  • 属性声明与初始化块
  • 次构造函数
  • 方法声明
  • 伴生对象

不要按字母顺序或者可见性对方法声明排序,也不要将常规方法与扩展方法分开。而是要把相关的东西放在一起,这样从上到下阅读类的人就能够跟进所发生事情的逻辑。选择一个顺序(高级别优先,或者相反)并坚持下去。

将嵌套类放在紧挨使用这些类的代码之后。如果打算在外部使用嵌套类,而且类中并没有引用这些类,那么把它们放到末尾,在伴生对象之后。


接口实现布局

在实现一个接口时,实现成员的顺序应该与该接口的成员顺序相同(如果需要, 还要插入用于实现的额外的私有方法)


重载布局

在类中总是将重载放在一起。

相关文章

  • Kotlin 文件管理规范

    文件名称 文件的名称应该描述文件中代码的作用,所以不要写无用词语。 如果 Kotlin 文件包含单个类(以及可能相...

  • 数据管理

    一些规范 1、文件管理 2、文件管理规范 3、数据质检 主要是一致性,正确性,及时性等考量

  • 磁盘文件管理规范

    本文为个人文件命名及管理的规范说明,其目的为了整理各类文档及便于everything进行搜索 0. 零级文件目录说...

  • linux文件系统

    Genaral windows使用磁盘分区等来进行管理,Linux下有文件管理标准FHS来进行规范。linux文件...

  • 微信小程序开发规范

    微信小程序里的四种文件 资源管理 资源文件 基础页面 样式文件 JS规范

  • 数据管理文件管理服务和文件管理规范

    # 数据文件的管理 建立合理的文件保存架构。所有文件、文件夹都要规范化命名。 定时集中对文件进行备份 统一制订文件...

  • 网易微专业-页面架构 规范

    1、规范:▪文件规范▪注释规范▪命名规范▪书写规范▪其他规范(HTML和图片) 2、文件规范⑴分类 ⑵引入 ⑶本身...

  • Kotlin基础语法

    Kotlin 基础语法 Kotlin 文件以 .kt 为后缀。 包声明 kotlin源文件不需要相匹配的目录和包,...

  • Kotlin I/O 与文件管理(4)文件管理

    File 类扩展函数案例:读取目录文件   在 Kotlin 中如果只是对文件进行操作,可以不直接使用文件流。Ko...

  • 日托:《体系文件更改培训》精益求精

    为了规范内部变更管理落实到位,重新梳理《文件变更管理规定》文件,并召集相关部门培训学习,了解各部门所需履行的...

网友评论

      本文标题:Kotlin 文件管理规范

      本文链接:https://www.haomeiwen.com/subject/tgmjxktx.html