Scala 方法名称长度约定

Posted 2023-02-25

【中文标题】Scala 方法名称长度约定

【英文标题】：Scala method name length convention

【发布时间】：2017-02-27 18:10:28

【问题描述】：

我正在研究影响应用程序可读性的代码异味。我遇到了很长的方法名称，我想知道是否有这样的约定。

我检查了naming conventions in the scaladocs，但它没有列出任何有关方法名称长度的信息。 我还检查了Scalastyle rules，发现它默认为 50。

对于方法名称的最大长度是否有官方约定，如果有，是多长？

【问题讨论】：

据我所知，没有“官方”或“商定”的数字。这在很大程度上取决于开发人员和审阅者的常识。根据风格，字数可以大幅度减少，就像这篇博文中建议的那样：degoes.net/articles/insufficiently-polymorphic

【参考方案1】：

Scalastyle 执行default the value to 50。

Paypal's Style Guide 提到“对于超过 30 个字符的函数名称，请尽量缩短名称。”

Databricks' Scala Style Guide 和 Twitter's Effective Scala 似乎都没有提到方法名称的长度。

就我个人而言，我确实认为 30 可能还是太多了（试着想象一下自己阅读的代码中散布着该方法名称，并尝试想象将它与另一个类似的方法区分开来会有多困难如果它们都很长）。

查看其他语言的模式和默认值可能很有用。我在这篇博文中整理了一些信息：Cross-language Best Practices。

【讨论】：

谢谢！我同意 50 似乎仍然偏多（除非是用于测试方法）。我会听取您的建议并将其与其他语言进行比较。