Block Comment Rules

Note

All examples in this section are using the following options:

  • header_left = ‘+’
  • header_left_repeat = ‘-’
  • header_string = ‘[ Header ]’
  • header_right_repeat = ‘=’
  • comment_left = ‘|’
  • footer_left = ‘+’
  • footer_left_repeat = ‘-’
  • footer_string = ‘[ Footer ]’
  • footer_right_repeat = ‘=’
  • min_height = 3
  • header_alignment = ‘center’
  • max_header_column = 40
  • footer_alignment = ‘right’
  • max_footer_column = 40

block_comment_001

phase_1 disabled error structure

This rule checks the block comment header is correct.

Refer to Configuring Block Comments for more information.

Violation

----------------------------------------
--   Comment
--   Comment
----------------------------------------

Fix

--+-------------[ Header ]==============
--   Comment
--   Comment
----------------------------------------

block_comment_002

phase_1 disabled error structure

This rule checks the comment_left attribute exists for all comments.

Refer to Configuring Block Comments for more information.

Violation

--+-------------[ Header ]==============
--   Comment
--   Comment
----------------------------------------

Fix

--+-------------[ Header ]==============
--|  Comment
--|  Comment
----------------------------------------

block_comment_003

phase_1 disabled error structure

This rule checks the block comment footer is correct.

Refer to Configuring Block Comments for more information.

Violation

--+-------------[ Header ]==============
--|  Comment
--|  Comment
----------------------------------------

Fix

--+-------------[ Header ]==============
--|  Comment
--|  Comment
--+--------------------------[ Footer ]=