Pinpoint: A virtual user conference Register today
Smarty

Go naming conventions

Smarty header pin graphic
Michael Whatcott
Michael Whatcott
 | 
October 18, 2018
Tags
Smarty header pin graphic

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 knew 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’re 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.
rss feed icon
Subscribe Now
Read our recent posts
Tariffs are high. Your address accuracy should be higher.
Arrow Icon
Tariffs are spiking. Shipping costs are climbing. Margins are shrinking. You can’t control global trade policy, but you can control how efficient and accurate your operations are in response. Most ecommerce teams, logistics planners, and data managers miss one of their best cost-saving opportunities: addressing accuracy. Bad address data isn’t hidden. It sits in your systems, shows up in carrier returns, and quietly drains profits every day. When tariffs rise to 15 to 50 percent in some product categories and import volumes are falling, every shipment becomes more expensive, every delay costs more, and every lost customer hurts more.
Pinpoint: The Smarty virtual user conference, because the world is better validated
Arrow Icon
November 2025 | 100% online | 100% awesomeJoin us this November for the Smarty Virtual User Conference, a two-day event packed with insights, tools, laughs, and $1000 worth of prizes. This event is for you, whether you’re optimizing delivery accuracy, improving compliance, or just trying to figure out if your neighbor really has a breakfast nook. What to expect:2 days, 12 hours of content, zero fluffLive sessions from address data prosHands-on demos of Smarty’s latest tools and pluginsGiveaways galore, like gift cards, swag, and even a chance at a massive LEGO setHidden Easter eggs throughout the event (no, seriously—find them and win)An after-party with games (shoutout to Brady Amundson)Tailored tracks for every roleFor developers:Roll up your sleeves.
Welcome to the Address Zoo #1 | Override & underride city addresses
Arrow Icon
The benefits of reliable, easy-to-implement address data are straightforward. Actual addresses, on the other hand, aren’t always so cut and dry. If you’re looking to become an expert in everything that begins or ends with an address, this series is for you. We’ll demystify the types of addresses that have developers scratching their heads and introduce you to the tools keeping your address data best-in-class. Come one, come all, and enter the wonderful world of peculiar addresses! Let’s see what’s on exhibit.

Ready to get started?