How can I customize comment block characters in Visual Studio Code?

by

OK, I finally figured out what the problem was.
There are two ways you can change the comment blocks:

1. Configuration file

I don’t know why it’s not in the documentation (or at least I couldn’t find it), but there is an optional property you pass to the object inside the contributes.languages array in the package.json file named configuration.

The description found on the Visual Studio Code source code:

A relative path to a file containing configuration options for the
language.

In those files you can create an object like this one and it’s going to overwrite the default comment characters

{
  "comments": {
    "lineComment": "//",
    "blockComment": [ "<!--", "-->" ]
  }
}

You can see this properties on the API references: CommentRule

Note: That comment block command is triggered with a different shortcut. You can overwrite it though (in a general or even for a specific language using the property when on the key binding object).

⇧⌥A – Toggle Block Comment – editor.action.blockComment

Key Bindings for Visual Studio Code

2. “Syntax” file .tmLanguage

Yes, you can do it from there too and you can make it even better.
You can see an example on vscode-handlebars/syntaxes/handlebars.tmLanguage.

More Related Contents:

  1. Create Custom Language in Visual Studio Code
  2. How to trigger documentation popup in vscode
  3. Where can I find a list of all possible keys for tm-themes for syntax highlighting?
  4. How to trigger documentation popup in VS Code?
  5. Enable or disable VS Code Integrated Terminal Tabs?
  6. How do I hide certain files from the sidebar in Visual Studio Code?
  7. How to make VS Code treat a file extensions as a certain language?
  8. Open files always in a new tab
  9. Vertical rulers in Visual Studio Code
  10. Install a Nuget package in Visual Studio Code
  11. How can I navigate back to the last cursor position in Visual Studio Code?
  12. LaTeX fraction snippets in VSCode
  13. Switch focus between editor and integrated terminal
  14. How to add multiple terminals in VS Code?
  15. How do you determine which formatter is being used for VS Code?
  16. Why do I keep getting “[eslint] Delete `CR` [prettier/prettier]”?
  17. How to correctly set PYTHONPATH for Visual Studio Code
  18. How can I open Visual Studio Code’s ‘settings.json’ file?
  19. How can you disable Gutter Indicators in VS Code?
  20. Visual Studio Code. why are the window control buttons over the menu bar on the left side?
  21. How to add a @tailwind CSS rule to CSS checker
  22. How to add semicolon to the end of the line in visual studio code
  23. How do I set the default browser as chrome in Visual Studio Code?
  24. Change highlight text color in Visual Studio Code
  25. How can I disable GPU rendering in Visual Studio Code
  26. How to make vscode not wait for finishing a preLaunchTask?
  27. How to change indent guide line color between brackets in VSCODE?
  28. How to unhide/show the ‘Activity Bar’ on Visual Studio Code?
  29. Can I automatically start a task when a folder is opened?
  30. Open multiple Projects/Folders in Visual Studio Code

Leave a Comment