GODOCS GOLANG CODE
GODOCS GOLANG WINDOWS

So if I can see documentation for the standard Go packages, then the source code for those packages must be on my machine. There are no extra files on my machine, LiteIDE is streaming the output of Godoc directly into the screen. Now I produced the same documentation I am seeing inside of LiteIDE. Godoc -html /Users/bill/Spaces/GoPackages/src/ArdanStudios/threadpool But I am seeing HTML inside of LiteIDE? I found the -html option. Suddenly the documentation appeared on my screen in text format. Godoc /Users/bill/Spaces/GoPackages/src/ArdanStudios/threadpool

GODOCS GOLANG WINDOWS

LOL, boy it is difficult coming from a Windows environment for the past 20 years.Īfter reading the documentation a bunch of times I opened up a Terminal session and ran the following command. The very first line states, ' Godoc extracts and generates documentation for Go programs.' Ok, so this program is being used by LiteIDE but how? Where are the files that Godoc is generating for all this documentation? Then I found this document from the Go team: So how the heck was this documentation being generated and published on the screen? So I looked around in both /usr/local/go and my own space to find the documentation files and there was nothing. There is only one problem, I haven’t created any documentation yet. I quickly reasoned that LiteIDE was using the GOROOT and GOPATH variables to find the documentation.

When I clicked on my package ArdanStudios/threadpool from within the LiteIDE Godoc search tool it used the pdoc URL scheme, pdoc:ArdanStudios/threadpool. The Godoc viewer will automatically open the package documentation for the chosen item.

Go File BrowserYou can open the Godoc viewer directly from the file browser by right clicking on a file or directory and selecting 'View Godoc Here'.

file:c:/go/doc/docs.html Automatic SchemesFor the 'file' and 'pdoc' schemes, you do not need to type the scheme as part of the URL.

pdoc:f:/hg/zmq/gozmq fileViews a specified HTML, Markdown, or plain-text file.

list:cmd - displays the Golang commands pdocViews documentation for a specified package or command.

list:pkg - displays the Golang packages.

The main choices are 'pkg' and 'cmd', which can be found as links in the header of the page.

find:godoc listLists all packages in a given directory.

When doing this, you can specify what type of documentation you are looking for by prefixing the address with one of the following URL schemes:įindSearches for packages with a specified string in their name. Supported URL SchemesIt is possible to view documentation by directly entering a URL into the Godoc viewer’s address bar.

The remainder of this page describes ways to invoke the Godoc viewer. Documentation can be viewed for both the official Go language as well as custom packages. OverviewThe integrated Godoc viewer in LiteIDE provides an easy way to browse documentation generated by the godoc tool without leaving the editor.

Godocs golang