parsecomment

package

v1.3.0 Latest Latest Go to latest Published: Jan 26, 2019 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package parsecomment parses the contract from the function comment.

This section is empty.

This section is empty.

This section is empty.

type Contract struct {
	Pres     []parsecond.Condition
	Posts    []parsecond.Condition
	Preamble string
}

Contract bundles the conditions and the preamble of the function's contract.

func ToContract(name string, commentLines []string) (c Contract, err error)

ToContract parses the contract from the function's documentation.

Path	Synopsis
parsecond Package parsecond parses the condition from the function documentation.	Package parsecond parses the condition from the function documentation.