Indentation

  • then (ro.amiq.vhdldt/format.indent.begin) - This option affects the then keyword placement:

    • Leave as is (1)

    • On a new line (2) - then is moved on a new line

    • On the same line (3) - then is moved on the same line with its construct

Initial code

Leave as is (1)

On a new line (2)

On the same line (3)
../../_images/then-same-line.png
../../_images/then-same-line.png
../../_images/then-new-line.png
../../_images/then-same-line.png
  • Parameters (ro.amiq.vhdldt/format.indent.params) - This option affects port, generic, map, function and procedure elements:

    • Leave as is (1)

    • One per line (open parenthesis on the same line) (2) - Each parameter/argument is placed on its own line and the open parentheses is placed on the same line with the parameter/argument receiver

    • One per line (open parenthesis on the next line) (3) - Each parameter/argument is placed on its own line and the open parentheses is placed on the next line after the parameter/argument receiver

    • More per line if less than (ro.amiq.vhdldt/format.indent.more_per_line_if_less_than_enable) - It controls whether to place parameters on the same line when their number does not exceed a specified value. This option is available only when the Parameters preference is set to One per line (open parenthesis on the same line) or One per line (open parenthesis on the next line).

    • More per line (4) - More parameters are placed on the same line

Note

When more parameters get to be placed on a single line and line wrapping is enabled, the parameters may be moved to separate lines as needed to fit within the specified line width.

Initial code & Leave as is (1)

More per line (4)
../../_images/parameters-before.png
../../_images/parameters-more-per-line-vhdl.png

Initial code

One per line (open parenthesis on the next line) (3)

One per line (open parenthesis on the next line) (3) and More per line if less than set to “5”

One per line (open parenthesis on the next line) (3) and More per line if less than set to “1”
../../_images/parameters-before.png
../../_images/parameters-one-per-line-open-parenthesis-on-the-next-line-vhdl.png
../../_images/parameters-open-paren-next-line-more-per-line-if-less-than-within-limit-vhdl.png
../../_images/parameters-one-per-line-open-parenthesis-on-the-next-line-vhdl.png

  • Don’t indent single line comments at first column (ro.amiq.vhdldt/format.indent.preserve_sl_comment_column_zero) - This option affects single line comments that start at column zero. It is useful to disable the indentation for whole regions of code that are block commented, for example by using Ctrl + /. When enabled, single line comments that start at column zero are not indented.

Before

After
../../_images/before-and-after-do-not-indent-single-line-comments-vhdl.png
../../_images/before-and-after-do-not-indent-single-line-comments-vhdl.png

  • Indent multi-line comments (ro.amiq.vhdldt/format.indent.multiline_comments) - This option affects multi-line comments (/* … */). When enabled, multi-line comments are indented.

Before

After
../../_images/before-indent-multiline-comments-vhdl.png
../../_images/after-indent-multiline-comments-vhdl.png

  • Ignore lines starting with (ro.amiq.vhdldt/format.indent.ignore_lines) - Space separated list of line prefixes. A line starting with one of the prefixes is completely ignored, that is it is not indented, nor it contributes to indentation.

Before

After
../../_images/before-ignore-lines-starting-with-vhdl.png
../../_images/after-ignore-lines-starting-with-vhdl.png

  • Don’t increase the indent level on (ro.amiq.vhdldt/format.indent.no_indent_keywords) - By default all scope language constructs increase indentation. This option allows you to control which language constructs should increase indentation.

Before

After
../../_images/before-no-indent-keywords-vhdl.png
../../_images/after-no-indent-keywords-vhdl.png