comment

README

gostaticanalysis/comment

comment provides utilities for ast.CommentMap.

Documentation

Index

• type Maps
  • func New(fset *token.FileSet, files []*ast.File) Maps
  • func (maps Maps) Annotated(n ast.Node, annotation string) bool
  • func (maps Maps) Comments(n ast.Node) []*ast.CommentGroup
  • func (maps Maps) CommentsByLine(fset *token.FileSet, line int) []*ast.CommentGroup
  • func (maps Maps) CommentsByPos(pos token.Pos) []*ast.CommentGroup
  • func (maps Maps) CommentsByPosLine(fset *token.FileSet, pos token.Pos) []*ast.CommentGroup
  • func (maps Maps) Ignore(n ast.Node, check string) bool
  • func (maps Maps) IgnoreLine(fset *token.FileSet, line int, check string) bool
  • func (maps Maps) IgnorePos(pos token.Pos, check string) bool
  • func (maps Maps) IgnorePosLine(fset *token.FileSet, pos token.Pos, check string) bool

Types

type Maps

type Maps []ast.CommentMap

Maps is slice of ast.CommentMap.

func New

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

New creates new a CommentMap slice from specified files.

func (Maps) Annotated

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

Annotated checks either specified AST node is annotated or not.

func (Maps) Comments

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

Comments returns correspond a CommentGroup slice to specified AST node.

func (Maps) CommentsByLine

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) CommentsByPos

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

CommentsByPos returns correspond a CommentGroup slice to specified pos.

func (Maps) CommentsByPosLine

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

CommentsByPosLine returns correspond a CommentGroup slice to specified line.

func (Maps) Ignore

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) IgnoreLine

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

Deprecated: This function does not work with multiple files. 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) IgnorePos

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

func (Maps) IgnorePosLine

func (maps Maps) IgnorePosLine(fset *token.FileSet, pos token.Pos, check string) bool

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

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