Соглашение о длине имени метода Scala
Я изучаю запахи кода, которые влияют на читабельность приложения. Я натолкнулся на длинные имена методов, и мне было интересно, есть ли соглашение для этого.
Я проверил соглашения об именах в scaladocs, но в нем ничего не указано о длине имени метода. Я также проверил правила Скаластиля и заметил, что по умолчанию он равен 50.
Существует ли официальное соглашение о максимальной длине имени метода, и если да, то как долго это будет продолжаться?
1 ответ
Scalastyle делает значение по умолчанию равным 50.
В Руководстве по стилю Paypal упоминается "Для имен функций длиной более 30 символов попробуйте сократить имя".
Ни в "Руководстве по стилю" Databricks, ни в "Эффективной Scala" в Twitter, похоже, не упоминается длина имени метода.
Лично я верю, что 30 все еще может быть слишком много (просто попробуйте представить себе, что читаете код с этим именем метода, разбросанным по всему тексту, и попытайтесь представить, насколько сложнее будет отличить его от другого подобного, если они как долго).
Может быть полезно взглянуть на шаблоны и настройки по умолчанию из других языков. В этой записи блога я собрал немного информации: " Наилучшие практики для разных языков".