Go Naming Conventions

 • 
October 18, 2018
Tags

It's been said that naming is one of the two hardest problems in computer science along with cache invalidation and 'off-by-one' errors. (See what I did there?) Do you ever find yourself wondering what policies and practices you could adopt to make your life easier when reading code you wrote months ago? Or maybe you're up at night wishing you know how to write code in such a way as to maximize adoption and convenience for your users? Well, look no further because we've anticipated the need, solved the problem, and now we're sharing our knowledge and wisdom at no charge, all out of the goodness of our hearts in this comprehensive, totally no-nonsense (nudge, nudge, wink, wink) style guide of Go naming conventions.

What you are about to read might actually be helpful at some point but we're not betting on it. Don't try this at home...actually, do try this at home--but maybe don't try it at work.

Table of Contents

  1. Export local variable names
  2. Export local const names
  3. Export input argument names
  4. Export output arguments names
  5. Export reciever names
  6. Use single-character receiver names
  7. Use single-letter argument names
  8. Use double-letter names when you run out of single-letter
  9. Actually, use a generic receiver name like 'this',
  10. For added emphasis, use extended unicode characters for receiver names
  11. Always define import aliases
  12. Always export all imports
  13. Use single-letter (exported) import aliases
  14. In the spirit of #8 (above), use double-letter alias names when necessary

1: Export local variable names

package main

import "fmt"

func main() {
	Message := "Always export local variable names"
	fmt.Println(Message)
}

https://go.dev/play/p/8WVCvJpoa59

2: Export local const names

package main

import "fmt"

func main() {
	const Message = "Always export constants defined in functions"
	fmt.Println(Message)
}

https://go.dev/play/p/-0yZhHVNOOs

3: Export input argument names

package main

import "fmt"

func main() {
	Print("Always export input argument names")
}

func Print(Message string) {
	fmt.Println(Message)
}

https://go.dev/play/p/utRBMOMQNgj

4: Export output arguments names

package main

import "fmt"

func main() {
	Print("Always export output argument names")
}

func Print(Message string) (N int, Err error) {
	return fmt.Println(Message)
}

https://go.dev/play/p/n5cJhLDKNWk

5: Export reciever names

package main

import "fmt"

func main() {
	new(Printer).Print("Always export receiver names")
}

type Printer struct{}

func (Printer *Printer) Print(Message string) (N int, Err error) {
	return fmt.Println(Message)
}

https://go.dev/play/p/jEN-zkrjxdT

6: Use single-character receiver names

package main

import "fmt"

func main() {
	new(Printer).Print(
		"Use only the first letter of a type as the receiver for its methods (oh, wait...), " + 
			"and (per tip #5) make sure the receiver is exported")
}

type Printer struct{}

func (P *Printer) Print(Message string) (N int, Err error) {
	return fmt.Println(Message)
}

https://go.dev/play/p/0OqQLnPPcVd

7: Use single-letter argument names

package main

import "fmt"

func main() {
	new(Printer).Print("Use single-letter variables whenever possible")
}

type Printer struct{}

func (P *Printer) Print(M string) (N int, E error) {
	return fmt.Println(M)
}

https://go.dev/play/p/Q1jgH_6h2kT

8: Use double-letter names when you run out of single-letter names

package main

import "fmt"

func main() {
	new(Printer).Print("Use double-letter variables when you run out of single-letter variables")
}

type Printer struct{}

func (P *Printer) Print(NN string) (N int, E error) {
	return fmt.Println(NN)
}

https://go.dev/play/p/k3p9Hf49-20

9: Actually, use a generic receiver name like 'this', 'self', or 'me'

package main

import "fmt"

func main() {
	new(Printer).Print("On second thought, use a generic receiver name like 'this', 'self', or 'me'.")
}

type Printer struct{}

func (this *Printer) Print(NN string) (N int, E error) {
	return fmt.Println(NN)
}

https://go.dev/play/p/mSMZRqUy4qw

10: For added emphasis, use extended unicode characters for receiver names

package main

import "fmt"

func main() {
	new(Printer).Print("See what I did here? ;)")
}

type Printer struct{}

func (𝕥𝕙𝕚𝕤 *Printer) Print(NN string) (N int, E error) {
	return fmt.Println(NN)
}

https://go.dev/play/p/VPpSDOZYYjT

11: Always define import aliases

package main

import fmt "fmt"

func main() {
	fmt.Println("Always define import aliases")
}

https://go.dev/play/p/zCOnEoNtAf4

12: Always export all imports

package main

import Fmt "fmt"

func main() {
	Fmt.Println("Always export all imports")
}

https://go.dev/play/p/_fEPiypASub

13: Use single-letter (exported) import aliases

package main

import F "fmt"

func main() {
	F.Println("Use single-letter (exported) import aliases")
}

https://go.dev/play/p/e8JQAlSKpnZ

14: In the spirit of #8 (above), use double-letter alias names when necessary

package main

import (
	F "flag"
	FF "fmt"
)

func main() {
	F.Parse()
	FF.Println("Use double-letter alias names when necessary")
}

https://go.dev/play/p/U0ac86PHUsb

Subscribe to our blog!
Learn more about RSS feeds here.
Subscribe Now
Get our latest eBook!
Evaluating a geocoding tool?
Get the buyer's guide
smarty logo
Download now
Read our recent posts
Rising Parcel Shipping Costs in 2022: How to Cut Your Shipping Expenses
Arrow Icon
Parcel shipping costs have been rising since 2020. We’ve all seen inflation on the consumer end, whether we’re checking out online or paying at the gas pump. And skyrocketing freight rates have made headlines. Today, we’re going to focus on the impact of the increasing cost of shipping on your business and what you can do about it. But don’t lose hope—while we’re going to explore climbing shipment costs in this article, we’ll also chat about what your business can do to make shipping more efficient.
How to Clean Address Data For the Holiday Rush
Arrow Icon
It’s November, and online shopping is ramping up to its climactic end-of-year blitz. www. blackfriday. com estimates that between Thanksgiving and Black Friday of this year, consumers will spend approximately $13 billion 1. That’s great news for your business. But if you don’t have the right tools in place to help you meet that demand, you might be left wishing you had better prepare. Staffing may be one issue for many businesses. According to the US Chamber of Commerce, the wholesale and retail trade industry has experienced the second-highest quit rate of all industries since November 20202.
Helpful Hints to Authenticating Your APIs
Arrow Icon
We brought out the big guns in the way of our Development Team Lead, Kent Gividen, in a webinar all about authenticating your APIs. He went over some of his most useful tips and tricks that he uses to ensure APIs are authenticated. Was it helpful? You betcha. You wanna get the sparknotes? Read on. Common and Not-So-Common APIs to Know About Kent began by outlining the APIs that he has run into the most in his years as a developer. Some of them he dug into a little deeper than others, but these are all useful to be aware of.

The leader in location data intelligence

Ready to get started?