Golang conventions: Difference between revisions

From wikinotes
No edit summary
Line 1: Line 1:
= Naming =
= Naming =
<blockquote>
<blockquote>
== Brevity ==
<blockquote>
Go prefers short names, with good doc comments for both functions and packages.<br>
Imported package names are typed every time a symbol is used.
</blockquote><!-- Brevity -->
== Casing ==
== Casing ==
<blockquote>
<blockquote>

Revision as of 03:44, 25 May 2022

Naming

Brevity

Go prefers short names, with good doc comments for both functions and packages.
Imported package names are typed every time a symbol is used.

Casing

func DoThing() { ... }  // exported functions are PascalCase
func doThing() { ... }  // regular functions are camelCase

Interfaces

// interfaces should end in 'er' (or similar)
Writer, Reader, Formatter, Notifier, Flusher, Stringer

// implementations of interfaces should drop the 'er'
Write, Read, Format, Notify, Flush, String

Spacing

TODO

Syntax

Semicolons

Go uses semicolons as line-endings, but prefers that the semicolon is implied automatically.