Go Style Guide

https://google.github.io/styleguide/go/guide
Admin
The Go Style Guide is Google's official style guide for writing readable, maintainable, and...
Tokens:3,696
Snippets:24
Trust Score:8.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Implicit Error Assignment in Go (Bad Practice)

Source: https://google.github.io/styleguide/go/guide/index

Shows an example of implicit error assignment using '=' instead of ':=' which can lead to unexpected behavior and reduced readability. This pattern is discouraged as it can be easily missed and cause bugs.

```go
// Bad:
// The use of = instead of := can change this line completely.
if user, err = db.UserByID(userID); err != nil {
    // ...
}
```

--------------------------------

### Go Error Handling Idiom

Source: https://google.github.io/styleguide/go/guide/index

Demonstrates the common and idiomatic way to check for errors in Go. This pattern is easily recognizable by Go developers, contributing to code readability.

```go
// Good:
if err := doSomething(); err != nil {
    // ...
}
```

--------------------------------

### Explicit Error Handling in Go

Source: https://google.github.io/styleguide/go/guide/index

Demonstrates a more explicit and readable way to handle errors compared to implicit assignment. This approach improves clarity by separating variable assignment from error checking.

```go
// Good:
u, err := db.UserByID(userID)
if err != nil {
    return fmt.Errorf("invalid origin user: %s", err)
}
user = u
```

--------------------------------

### Complex Boolean Logic in Go (Bad Practice)

Source: https://google.github.io/styleguide/go/guide/index

Presents a complex boolean expression for leap year calculation where a single character '!' can be easily missed, leading to potential errors. This demonstrates the importance of breaking down complex logic for better maintainability.

```go
// Bad:
// The ! in the middle of this line is very easy to miss.
leap := (year%4 == 0) && (!(year%100 == 0) || (year%400 == 0))
```

--------------------------------

### Go Error Handling Idiom with Signal Boost

Source: https://google.github.io/styleguide/go/guide/index

Illustrates how to intentionally highlight a specific error check, particularly when the condition is inverted (checking for no error). This 'signal boost' uses a comment to draw attention to the subtle change.

```go
// Good:
if err := doSomething(); err == nil { // if NO error
    // ...
}
```

--------------------------------

### Clear Leap Year Calculation in Go

Source: https://google.github.io/styleguide/go/guide/index

Illustrates a more explicit and readable way to calculate leap years by breaking down the logic into intermediate boolean variables. This avoids a complex, single-line expression that can be hard to parse.

```go
// Good:
// Gregorian leap years aren't just year%4 == 0.
// See https://en.wikipedia.org/wiki/Leap_year#Algorithm.
var (
    leap4   = year%4 == 0
    leap100 = year%100 == 0
    leap400 = year%400 == 0
)
leap := leap4 && (!leap100 || leap400)
```
Tokens:
Raw