Style-CommentAnnotation.md

Pattern: Malformed comment annotation

Issue: -

Description

This rule checks that comment annotation keywords are written according to guidelines i.e. keyword is followed by a colon and a space, then a note describing the problem.

Default configuration

Attribute	Value
Keywords	TODO, FIXME, OPTIMIZE, HACK, REVIEW

Further Reading

• RuboCop - Style/CommentAnnotation
• https://github.com/bbatsov/ruby-style-guide#annotate-keywords