Best practices in Go - Step-by-Step Execution

Concept Flow - Best practices

Write clear code

↓

Use meaningful names

↓

Keep functions small

↓

Handle errors properly

↓

Write comments wisely

↓

Test your code

↓

Review and refactor

↓

Maintain consistency

↓

Deploy with confidence

This flow shows the main steps to write good Go code, from writing clear code to deploying confidently.

Execution Sample

Go

package main
import "fmt"

func main() {
    result, err := divide(10, 2)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println("Result:", result)
}

func divide(a, b int) (int, error) {
    if b == 0 {
        return 0, fmt.Errorf("cannot divide by zero")
    }
    return a / b, nil
}

This Go program divides two numbers safely, showing error handling and clear function design.

Execution Table

Step	Action	Evaluation	Result
1	Call divide(10, 2)	b == 0? false	Returns 5, nil
2	Check err in main	err != nil? false	Continue
3	Print result	fmt.Println("Result:", 5)	Output: Result: 5
4	Call divide(10, 0)	b == 0? true	Returns 0, error
5	Check err in main	err != nil? true	Print error and return
6	Program ends	-	-

💡 Program ends after handling error or printing result.

Variable Tracker

Variable	Start	After Step 1	After Step 4	Final
a	-	10	10	10
b	-	2	0	0
result	-	5	0	0
err	-	nil	error("cannot divide by zero")	error("cannot divide by zero")

Key Moments - 3 Insights

Why do we check if err != nil after calling divide?

Because divide can return an error (like dividing by zero). Checking err prevents the program from continuing with bad data. See execution_table rows 2 and 5.

Why does divide return two values instead of one?

In Go, functions often return a value and an error separately. This helps handle problems clearly. See execution_table row 1 and 4.

Why keep functions small and focused?

Small functions are easier to read, test, and fix. The divide function only does division and error check, making it simple and clear.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of 'result' after Step 1?

A nil

B 5

C 0

D error

💡 Hint

Check the 'Result' column in execution_table row 1.

At which step does the program detect a division by zero?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look for where b == 0 is true in execution_table.

If we remove the error check in main, what happens?

A Program prints the result even if error occurs

B Program stops immediately

C Program crashes at compile time

D Program prints error message twice

💡 Hint

Refer to execution_table rows 2 and 5 about error handling.

Concept Snapshot

Best practices in Go:
- Write clear, readable code
- Use meaningful variable and function names
- Keep functions small and focused
- Always check and handle errors
- Write comments only when needed
- Test your code regularly
- Refactor and keep code consistent

Full Transcript

This visual execution shows best practices in Go programming. It traces a simple program that divides two numbers safely. The program uses a small function 'divide' that returns a result and an error. The main function checks the error before printing the result. This teaches clear code, meaningful names, small functions, and proper error handling. The execution table shows each step, variable changes, and decisions. Key moments explain why error checks are important and why small functions help. The quiz tests understanding of variable values and error detection. The snapshot summarizes best practices for writing good Go code.

Practice

1. Which of the following is a best practice when naming variables in Go?

easy

A. Use clear and descriptive names that explain the variable's purpose

B. Use single letters for all variable names to save space

C. Use names with special characters to make them unique

D. Use very long names with unnecessary details

Solution

1. Step 1: Understand variable naming importance

   Clear and descriptive names help others understand what the variable holds.

2. Step 2: Evaluate each option

   Using single letters or special characters makes code confusing. Very long names are hard to read.

3. Final Answer:

   Use clear and descriptive names that explain the variable's purpose -> Option A

4. Quick Check:

   Clear names improve readability [OK]

Hint: Pick option promoting clarity and readability [OK]

Common Mistakes:

• Choosing short, unclear variable names
• Using special characters in names
• Making names unnecessarily long

2. Which of the following Go code snippets correctly handles an error returned by a function?

easy

A. result, err := doSomething()
if err = nil {
fmt.Println("Error occurred")
}

B. result, err := doSomething()
if err == nil {
fmt.Println("Error occurred")
}

C. result, err := doSomething()
if err != nil {
fmt.Println("Error occurred")
}

D. result, _ := doSomething()
fmt.Println(result)

Solution

1. Step 1: Identify correct error check syntax

   In Go, errors are checked with 'if err != nil' to detect an error.

2. Step 2: Check each option's error handling

   result, err := doSomething() if err != nil { fmt.Println("Error occurred") } prints an error message when err is not nil, which is correct. result, err := doSomething() if err == nil { fmt.Println("Error occurred") } checks err == nil incorrectly. result, err := doSomething() if err = nil { fmt.Println("Error occurred") } uses assignment '=' instead of comparison '=='. result, _ := doSomething() fmt.Println(result) ignores the error by using _ and prints the result anyway, which is incorrect.

3. Final Answer:

   result, err := doSomething() if err != nil { fmt.Println("Error occurred") } -> Option C

4. Quick Check:

   Check error with 'err != nil' [OK]

Hint: Remember: error check is 'if err != nil' [OK]

Common Mistakes:

• Using '=' instead of '==' in conditions
• Checking 'err == nil' to detect errors
• Ignoring errors without handling

3. What will be the output of the following Go code?

package main
import "fmt"
func main() {
    nums := []int{1, 2, 3}
    sum := 0
    for _, n := range nums {
        sum += n
    }
    fmt.Println(sum)
}

medium

A. 6

B. 123

C. 0

D. Error

Solution

1. Step 1: Understand the loop and sum calculation

   The loop goes through each number in nums: 1, 2, 3 and adds them to sum.

2. Step 2: Calculate the sum

   sum = 0 + 1 + 2 + 3 = 6

3. Final Answer:

   6 -> Option A

4. Quick Check:

   Sum of [1,2,3] = 6 [OK]

Hint: Sum elements by adding each in the loop [OK]

Common Mistakes:

• Concatenating numbers as strings
• Starting sum from wrong initial value
• Misunderstanding range loop syntax

4. Identify the error in the following Go code snippet and choose the best fix:

func divide(a, b int) int {
    return a / b
}

func main() {
    result := divide(10, 0)
    fmt.Println(result)
}

medium

A. Change function to return float64 instead of int

B. Add error handling to check if b is zero before dividing

C. Remove the divide function and do division inline

D. Ignore the error since Go handles division by zero automatically

Solution

1. Step 1: Identify the problem with division by zero

   Dividing by zero causes a runtime panic in Go, which must be prevented.

2. Step 2: Choose the fix that prevents panic

   Adding error handling to check if b is zero before dividing avoids the panic. Changing return type or removing function does not fix the error. Go does not handle division by zero automatically.

3. Final Answer:

   Add error handling to check if b is zero before dividing -> Option B

4. Quick Check:

   Prevent division by zero [OK]

Hint: Always check divisor before dividing to avoid panic [OK]

Common Mistakes:

• Ignoring division by zero errors
• Assuming Go handles zero division safely
• Changing return type without fixing logic

5. You want to write a Go function that returns a map of words to their counts from a slice of strings. Which approach follows best practices for clarity, error handling, and simplicity?

hard

A. Use nested loops to count words multiple times for accuracy

B. Use global variables to store counts and update them inside the function

C. Return a pointer to the map and panic if input slice is empty

D. Use a simple loop to count words, return the map, and handle empty input gracefully

Solution

1. Step 1: Understand best practices for function design

   Functions should be simple, clear, and handle edge cases like empty input without panicking.

2. Step 2: Evaluate each option

   Use a simple loop to count words, return the map, and handle empty input gracefully uses a simple loop and handles empty input gracefully, which is best practice. Use nested loops to count words multiple times for accuracy is inefficient with nested loops. Return a pointer to the map and panic if input slice is empty uses panic and pointers unnecessarily. Use global variables to store counts and update them inside the function uses global variables, which reduces clarity and safety.

3. Final Answer:

   Use a simple loop to count words, return the map, and handle empty input gracefully -> Option D

4. Quick Check:

   Simple, clear, safe function [OK]

Hint: Keep functions simple and handle edge cases safely [OK]

Common Mistakes:

• Using complex nested loops unnecessarily
• Panicking instead of returning errors
• Using global variables inside functions