В проектах Go большое внимание уделяется простоте и удобочитаемости, поэтому в нем используются некоторые простые правила и соглашения, гарантирующие, что исходные коды можно поддерживать и легко понять.
Правила именования файлов в GO
Для именования файлов и модулей в golang принято использовать змениную нотацию или snake_case
— стиль со следующими особенностями:
- go следует соглашению, согласно которому все исходные файлы должны иметь нижний регистр;
- составные имена разделяются символом нижнего подчеркивания «
_
»; - имена файлов, начинающиеся с сивмолов «
.
» или «_
» игнорируются инструментами go; - файлы с суффиксом
_test.go
компилируются и запускаются только с помощью инструментаgo test
.
Правила именования функций и методов в GO
Для именования функций принято использовать верблюжую нотацию или CamelCase
— стиль со следующими особенностями:
- если функция начинается с заглавной буквы, то она способна экспортироваться из модуля
- если функция начинается с прописной буквы, то она закрыта для экспорта из модуля
Правила именования констант в GO
В константах следует использовать заглавные буквы и использовать подчеркивание «_
» для разделения слов.
Правила именования переменных в GO
- обычно используйте относительно простое (короткое) имя;
- во всем исходном коде должен использоваться единый стиль именования
- если тип переменной —
bool
, ее имя должно начинаться сHas
,Is
,Can
илиAllow
и т. д. - одна буква представляет индекс:
i
,j
,k
.
примеры:
var user // можно упростить до u
var userID // можно упростить до uid
Для дополнительного изучения есть отличная статья про лучшие практики по стилю написания. кода на Go.