Оценок пока нет Условные правила именования файлов, функций , переменных и констант в golang

В проектах Go большое внимание уделяется простоте и удобочитаемости, поэтому в нем используются некоторые простые правила и соглашения, гарантирующие, что исходные коды можно поддерживать и легко понять.

Правила именования файлов в GO

Для именования файлов и модулей в golang принято использовать змениную нотацию или snake_case — стиль со следующими особенностями:

  1. go следует соглашению, согласно которому все исходные файлы должны иметь нижний регистр;
  2. составные имена разделяются символом нижнего подчеркивания «_»;
  3. имена файлов, начинающиеся с сивмолов «.» или «_» игнорируются инструментами go;
  4. файлы с суффиксом _test.go компилируются и запускаются только с помощью инструмента go test.

Правила именования функций и методов в GO

Для именования функций принято использовать верблюжую нотацию или CamelCase — стиль со следующими особенностями:

  • если функция начинается с заглавной буквы, то она способна экспортироваться из модуля
  • если функция начинается с прописной буквы, то она закрыта для экспорта из модуля

Правила именования констант в GO

В константах следует использовать заглавные буквы и использовать подчеркивание «_» для разделения слов.

Правила именования переменных в GO

  1. обычно используйте относительно простое (короткое) имя;
  2. во всем исходном коде должен использоваться единый стиль именования
  3. если тип переменной — bool, ее имя должно начинаться с Has, Is, Can или Allow и т. д.
  4. одна буква представляет индекс: i, j, k.

примеры:

var user // можно упростить до u
var userID // можно упростить до uid

Для дополнительного изучения есть отличная статья про лучшие практики по стилю написания. кода на Go.

Пожалуйста, оцените материал

WebSofter

Web - технологии