2016-10-18 2 views
0

Я изучаю запахи кода, которые влияют на читаемость приложения. Я натолкнулся на длинные имена методов, и мне было интересно, существует ли для этого соглашение.Scala method name length convention

Я проверил naming conventions in the scaladocs, но в нем ничего не указано о длине имени метода. Я также проверил Scalastyle rules и заметил, что по умолчанию он равен 50.

Есть ли официальное соглашение о максимальной длине имени метода, и если да, то сколько это?

+1

Нет никаких «официальных» или «согласованных» цифр, насколько я знаю. Это зависит от здравого смысла разработчика и рецензента. Согласно стилю, количество персонажей может существенно снизиться, как это предлагается в этом сообщении в блоге: http://degoes.net/articles/insufficiently-polymorphic – stefanobaghino

ответ

6

Scalastyle is default the value to 50.

Paypal's Style Guide упоминает «Для имен функций более 30 символов попробуйте сократить имя».

Ни Databricks' Scala Style Guide, ни Twitter's Effective Scala, кажется, упоминают длину имени метода.

Лично я полагаю, что 30 может быть слишком большим (просто попробуйте представить себе, как вы читаете код с таким именем метода, разбросанным по нему, и попытайтесь представить, насколько сложнее будет отличить его от другого подобного один, если они оба длинные).

Возможно, было бы полезно изучить шаблоны и значения по умолчанию с других языков. Я собрал немного информации в этом блоге: Cross-language Best Practices.

+0

Спасибо! Я согласен с тем, что 50 по-прежнему кажется длинной (если только для методов тестирования). Я возьму ваш совет и сравню его с другими языками. – RemcoW