comment

Documentation

Index

• type Comment
• type Comments
  • func (c Comments) AddComments(node node.Node, comments []Comment)
• type DocComment
  • func NewDocComment(value string) *DocComment
  • func (c *DocComment) String() string
• type PlainComment
  • func NewPlainComment(value string) *PlainComment
  • func (c *PlainComment) String() string

Types

type Comment

type Comment interface {
	String() string
}

Comment represents comment lines in the code

type Comments

type Comments map[node.Node][]Comment

Comments a collection of comment groups assigned to nodes

func (Comments) AddComments

func (c Comments) AddComments(node node.Node, comments []Comment)

AddComments add comment group to the collection

type DocComment

type DocComment struct {
	// contains filtered or unexported fields
}

DocComment represents comments that start /**

func NewDocComment

func NewDocComment(value string) *DocComment

NewDocComment - DocComment constructor

func (*DocComment) String

func (c *DocComment) String() string

type PlainComment

type PlainComment struct {
	// contains filtered or unexported fields
}

PlainComment represents comments that dont start /**

func NewPlainComment

func NewPlainComment(value string) *PlainComment

NewPlainComment - PlainComment constructor

func (*PlainComment) String

func (c *PlainComment) String() string