Go style guides: избегайте голых параметров

Голые параметры в вызовах функций могут ухудшить читаемость. Добавляйте комментарии в C-стиле (/* ... */) для имен параметров, когда их значение неочевидно.

Менее удачный пример:

// func printInfo(name string, isLocal, done bool)

printInfo("foo", true, true)

Более удачный пример:

// func printInfo(name string, isLocal, done bool)

printInfo("foo", true /* isLocal */, true /* done */)

А еще лучше заменить голые типы bool пользовательскими типами для более читаемого и безопасного кода. Это позволяет использовать более двух состояний (true/false) для этого параметра в будущем.

type Region int

const (
    UnknownRegion Region = iota
    Local
)

type Status int

const (
    StatusReady Status = iota + 1
    StatusDone
    // Возможно, в будущем у нас будет StatusInProgress.
)

func printInfo(name string, region Region, status Status)

---

Читайте также:

• Go style guides: объявления локальных переменных
• Go style guides: nil - это допустимый срез
• Go style guides: уменьшайте область видимости переменных

Канал в Телеграм