В проекте Go большое внимание уделяется простоте и удобочитаемости, поэтому он принимает некоторые простые соглашения, гарантирующие поддержку исходных кодов.
Вы, должно быть, уже видели кое-что из этого в Учебнике по Go и Effective Go. В этой статье перечислены только некоторые хорошо известные соглашения при написании вашего проекта Go.
Файлы
- Go следует соглашению, согласно которому все исходные файлы записываются в нижнем регистре с подчеркиванием, разделяющим несколько слов.
- Имена составных файлов разделяются знаком _
- Имена файлов, начинающиеся с "." или "_" игнорируются инструментом go
- Файлы с суффиксом
_test.go
компилируются и запускаются только инструментомgo test
.
Функции и методы
Используйте верблюжий регистр, экспортируемые функции должны начинаться с верхнего регистра:
writeToDB // unexported, only visible within the package
WriteToDB // exported, visible within the package
Константы
Константа должна использовать все заглавные буквы и использовать подчеркивание _
для разделения слов.
Переменные
- Как правило, используйте относительно простое (короткое) имя.
- Единый стиль именования должен использоваться весь исходный код.
user
to u
userID
to uid
- Если тип переменной
bool
, ее имя должно начинаться сHas
,Is
,Can
илиAllow
и т. Д. - Одна буква представляет индекс:
i, j, k
У Дэйва есть отличная статья о том, как писать добро и качество.
Пройдите тест на Golang прямо сейчас Проверьте The Ultimate Go (Golang) Programming Challenge на Udemy