我正在研究会对应用程序的可读性产生影响的代码气味。我遇到了很长的方法名称,我想知道是否有一个约定。
我已经检查了naming conventions in the scaladocs,但没有列出任何有关方法名称长度的内容。 我还检查了Scalastyle rules并注意到它默认为50。
是否存在方法名称最大长度的官方约定,如果有,需要多长时间?
答案 0 :(得分:6)
Scalastyle做default the value to 50。
Paypal's Style Guide提及“对于超过30个字符的函数名称,请尝试缩短名称。”
Databricks' Scala Style Guide和Twitter's Effective Scala似乎都没有提及方法名称长度。
就个人而言,我确实认为30可能仍然太多(只是试图想象自己阅读的代码名称分散在整个代码中,并试图想象将它与另一个相似的方法区分得多么困难如果他们都很长。)
查看模式和其他语言的默认值可能很有用。我在这篇博文中汇编了一些信息:Cross-language Best Practices。