Kotlin的文件命名约定

Question

Kotlin删除了Java"每个文件的一个顶级公共类"限制,我已经学会了爱.我想知道是否有理由讨论这个问题以及是否有一些指导如何应对这种新的自由？

Answer 1

您仍然可以将该Java规则用作约定,并在类之后命名文件.或者你可以开始将更多的类放入一个Kotlin文件中,在这种情况下我建议在它们的目的之后命名文件.每个文件通常都包含彼此相关的类或其他顶级元素(如果它们不相同,可能它们首先不属于同一个文件？).应该有单个单词或少量单词表示单个文件中所有类的目的,这是文件名的自然候选者.

Answer 2

在Kotling.org 上，您可以找到解决所有疑问的编码约定文档。

如果可以，我认为从上述页面中提取的这些部分可能对您有用：

源文件名

如果 Kotlin 文件包含单个类（可能带有相关的顶级声明），则其名称应与类的名称相同，并附加 .kt 扩展名。如果文件包含多个类，或仅包含顶级声明，请选择描述文件内容的名称，并相应地命名文件。使用带有大写首字母的驼峰（例如 ProcessDeclarations.kt）。

文件名应该描述文件中代码的作用。因此，您应该避免在文件名中使用无意义的词，例如“Util”。

和...

源文件组织

鼓励在同一个 Kotlin 源文件中放置多个声明（类、顶级函数或属性），只要这些声明在语义上彼此密切相关并且文件大小保持合理（不超过几百行）。特别是，当为与该类的所有客户端相关的类定义扩展函数时，请将它们放在定义类本身的同一文件中。在定义仅对特定客户端有意义的扩展函数时，将它们放在该客户端的代码旁边。不要创建文件只是为了保存“Foo 的所有扩展名”。

有关您可能遇到的任何其他问题，请参阅文档。

我认为重点是选择适合您团队的编码约定。也就是说，我认为这个 Kotlin.org 约定可以被视为一种标准，我希望任何 Kotlin 开发人员至少知道（如果没有遵循），并且是任何项目的默认选择，除非有令人信服的理由改变。