Interface TodoComment

A parsed TODO (or other tag) comment

[{
  file: 'parsedFile.js',
  line: 8,
  ref: 'reference'
  tag: 'TODO',
  text: 'comment text',
}]

Properties

file: string

The filetype the comment originated from

line: number

Line number the comment was found in file

ref: string

A possible reference used (either as prefix or postfix)

tag: string

The comment tag (usually TODO)

text: string

The TODO (or other tag) text