comment

package module

v1.4.2 Latest Latest Go to latest Published: Mar 3, 2021 License: MIT Imports: 3 Imported by: 29

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

comment provides utilities for ast.CommentMap.

This section is empty.

This section is empty.

This section is empty.

type Maps []ast.CommentMap

Maps is slice of ast.CommentMap.

func New(fset *token.FileSet, files []*ast.File) Maps

New creates new a CommentMap slice from specified files.

func (maps Maps) Annotated(n ast.Node, annotation string) bool

Annotated checks either specified AST node is annotated or not.

func (maps Maps) Comments(n ast.Node) []*ast.CommentGroup

Comments returns correspond a CommentGroup slice to specified AST node.

func (maps Maps) CommentsByLine(fset *token.FileSet, line int) []*ast.CommentGroup

Deprecated: This function does not work with multiple files. CommentsByPosLine can be used instead of CommentsByLine.

CommentsByLine returns correspond a CommentGroup slice to specified line.

func (maps Maps) CommentsByPos(pos token.Pos) []*ast.CommentGroup

CommentsByPos returns correspond a CommentGroup slice to specified pos.

func (maps Maps) CommentsByPosLine(fset *token.FileSet, pos token.Pos) []*ast.CommentGroup

CommentsByPosLine returns correspond a CommentGroup slice to specified line.

func (maps Maps) Ignore(n ast.Node, check string) bool

Ignore checks either specified AST node is ignored by the check. It follows staticcheck style as the below.

//lint:ignore Check1[,Check2,...,CheckN] reason

func (maps Maps) IgnoreLine(fset *token.FileSet, line int, check string) bool

IgnoreLine checks either specified lineof AST node is ignored by the check. It follows staticcheck style as the below.

//lint:ignore Check1[,Check2,...,CheckN] reason

func (maps Maps) IgnorePos(pos token.Pos, check string) bool

IgnorePos checks either specified postion of AST node is ignored by the check. It follows staticcheck style as the below.

//lint:ignore Check1[,Check2,...,CheckN] reason

Path	Synopsis
passes
commentmap