Files
zyedidia.micro/runtime/plugins/comment/help/comment.md

1.6 KiB

Comment Plugin

The comment plugin provides auto commenting/uncommenting. The default binding to comment/uncomment a line is Alt-/, but you can easily modify that in your bindings.json file:

{
    "Alt-g": "comment.comment"
}

You can also execute a command which will do the same thing as the binding:

> comment

If you have a selection, the plugin will comment all the lines selected.

The comment type will be auto detected based on the filetype, but it is only available for certain filetypes:

  • apacheconf: # %s
  • bat: :: %s
  • c: // %s
  • c++: // %s
  • cmake: # %s
  • conf: # %s
  • crystal: # %s
  • css: /* %s */
  • d: // %s
  • dart: // %s
  • dockerfile: # %s
  • elm: -- %s
  • fish: # %s
  • gdscript: # %s
  • glsl: // %s
  • go: // %s
  • haskell: -- %s
  • html: <!-- %s -->
  • ini: ; %s
  • java: // %s
  • javascript: // %s
  • jinja2: {# %s #}
  • julia: # %s
  • kotlin: // %s
  • lua: -- %s
  • markdown: <!-- %s -->
  • nginx: # %s
  • nim: # %s
  • objc: // %s
  • pascal: { %s }
  • perl: # %s
  • php: // %s
  • pony: // %s
  • powershell: # %s
  • proto: // %s
  • python: # %s
  • python3: # %s
  • ruby: # %s
  • rust: // %s
  • scala: // %s
  • shell: # %s
  • sql: -- %s
  • swift: // %s
  • tex: % %s
  • toml: # %s
  • twig: {# %s #}
  • v: // %s
  • xml: <!-- %s -->
  • yaml: # %s
  • zig: // %s
  • zscript: // %s
  • zsh: # %s

If your filetype is not available here, you can simply modify the commenttype option:

set commenttype "/* %s */"

Or in your settings.json:

{
    "*.c": {
        "commenttype": "/* %s */"
    }
}