Golang go/doc.Examples() function example

package go/doc

Examples returns the examples found in the files, sorted by Name field. The Order fields record the order in which the examples were encountered.

Playable Examples must be in a package whose name ends in "_test". An Example is "playable" (the Play field is non-nil) in either of these circumstances:

The example function is self-contained: the function references only identifiers from other packages (or predeclared identifiers, such as "int") and the test file does not include a dot import.

The entire test file is the example: the file contains exactly one example function, zero test or benchmark functions, and at least one top-level function, type, variable, or constant declaration other than the example function.

Golang go/doc.Examples() function usage example

 var files []*ast.File
 var examples []*doc.Example

 for _, e := range doc.Examples(files...) {
 name := stripExampleSuffix(e.Name)
 if name == "" || globals[name] {
 examples = append(examples, e)
  } else if c.Verbose {
  log.Printf("skipping example 'Example%s' because '%s' is not a known function or type", e.Name, e.Name)
 }
 }

Reference :

http://golang.org/pkg/go/doc/#Examples

Golang go/doc.Examples() function example

Advertisement

Something interesting

Tutorials