Golang packages: Difference between revisions
From wikinotes
No edit summary |
|||
Line 1: | Line 1: | ||
= Basics = | |||
<blockquote> | |||
* Packages are groups of related code. | |||
* Exported functions are callable when a package is imported | |||
* The <code>main</code> package is your program's entrypoint (ex. cli) | |||
</blockquote><!-- Basics --> | |||
= Imports = | = Imports = | ||
<blockquote> | <blockquote> |
Revision as of 13:33, 29 May 2022
Basics
- Packages are groups of related code.
- Exported functions are callable when a package is imported
- The
main
package is your program's entrypoint (ex. cli)
Imports
import "fmt" import ( "fmt" // builtin pkgs have no module-path prefix "golang.org/x/example/stringutil" // non-builtin pkgs have module-path prefix (incl. local sub-packages) )
Defining Packages
Anatomy
# project heirarchy myproject/ mypackage/ libfoo.go libbar.go main.go go.mod
myproject/go.mod
// go.mod module github.com/you/myproject go 1.18
myproject/main.go
// main.go package main import "github.com/you/myproject/mypackage" func main() { mypackage.PrintHi(); }
myproject/mypackage/libfoo.go
// mypackage/libfoo.go package mypackage import "fmt" func PrintHi() { fmt.Println("hi") }Exported Functions
TODO:
Needs much more detail, and confirmation. (ex. what about constants? classes?)
Only exported symbols are exposed when a package is imported.
- Exported functions are upper-cased.