Skip to content

Jooseppi12/better-comments

 
 

Repository files navigation

Better Comments

The Better Comments extension will help you create more human-friendly comments in your code. With this extension, you will be able to categorise your annotations into:

  • Alerts
  • Queries
  • TODOs
  • Highlights
  • Commented out code can also be styled to make it clear the code shouldn't be there
  • Any other comment styles you'd like can be specified in the settings

Annotated code

Configuration

This extension can be configured in User Settings or Workspace settings.

'better-comments.multilineComments': true This setting will control whether multiline comments are styled using the annotation tags. When false, multiline comments will be presented without decoration.

better-comments.tags The tags are the characters or sequences used to mark a comment for decoration. The default 5 can be modifed to change the colors, and more can be added.

[{
  `tag`: '!',
  `color`: '#FF2D00',
  `strikethrough`: false
},{
  `tag`: '?',
  `color`: '#3498DB',
  `strikethrough`: false
},{
  `tag`: '//',
  `color`: '#474747',
  `strikethrough`: true
},{
  `tag`: 'todo',
  `color`: '#FF8C00',
  `strikethrough`: false
},{
  `tag`: '*',
  `color`: '#98C379',
  `strikethrough`: false
}]

Supported Languages

  • Ada
  • C
  • CoffeeScript
  • CSS
  • C++
  • C#
  • D
  • Dockerfile
  • Elixir
  • Erlang
  • F#
  • Go
  • Groovy
  • Haskell
  • Haxe
  • Kotlin
  • Java
  • JavaScript
  • JavaScript React
  • LaTex
  • Less
  • Lua
  • Makefile
  • Objective-C
  • Objective-C++
  • Perl
  • Perl 6
  • PHP
  • PL/SQL
  • PowerShell
  • Python
  • R
  • Rust
  • Ruby
  • Sass
  • Scala
  • SCSS
  • ShaderLab
  • ShellScript
  • SQL
  • Swift
  • TypeScript
  • Visual Basic