Better Comments extension for CFML development in VSCode

This is an example of using the Better Comments extension for CFML development in VSCode .

The Better Comments extension visually highlights specially tagged comments (like TODO, !, or ?) using colors and styles so important notes, questions, and tasks stand out instantly in your code.

You can define custom styles in either User or Workspace settings.json. You can set the color or backgroundColor, as well as underline, strikethrough, bold, and italic.

Example of a custom LUCEEONLY comment:

    "better-comments.tags": [
        {
            "tag": "luceeonly",
            "color": "#3CBED0",
            "strikethrough": false,
            "underline": false,
            "backgroundColor": "#transparent",
            "bold": true,
            "italic": false
        }
    ]

Gotcha 1: You must define all better-comments.tags in one location. Better Comments does not merge tag arrays.

Gotcha 2: When using CFML block comments in tag-based ColdFusion files, you must use // as the first non-whitespace characters after the opening comment tag for Better Comments to recognize the comment type.

Changes to settings may require reloading the VS Code window to take effect:

CMD+SHIFT+P > Developer: Reload Window

Results below:

Better Comments extension for CFML development in VSCode
Better Comments extension for CFML development in VSCode

2 thoughts on “Better Comments extension for CFML development in VSCode”

  1. Here’s the link to “Better Comments” VSCode extension:
    https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments

    Do you have any opinion of the forked “Even Better Comments”?
    https://marketplace.visualstudio.com/items?itemName=Tion.evenbettercomments

    I’ve been using the “TODO Highlight V2” VSCode extension to highlight “TODO:” and “FIXME:” keywords.
    https://marketplace.visualstudio.com/items?itemName=jgclark.vscode-todo-highlight

Leave a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.