Golang conventions: Difference between revisions
From wikinotes
(→Naming) |
|||
Line 5: | Line 5: | ||
Go prefers short names, with good doc comments for both functions and packages.<br> | 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. | Imported package names are typed every time a symbol is used. | ||
Go also prefers you drop the <code>get</code> prefix of getters. | |||
</blockquote><!-- Brevity --> | </blockquote><!-- Brevity --> | ||
Revision as of 03:48, 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.Go also prefers you drop the
get
prefix of getters.Casing
func DoThing() { ... } // exported functions are PascalCase func doThing() { ... } // regular functions are camelCaseInterfaces
// 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.