Dart (extension .dart) is a language from Google that includes JS-style comments,
including the block comment (/* */) and the line comment (// . . . ).

I use Visual Studio Code daily for writing Dart code and I really want to try out your
extension, thanks!

Comments in Rust can start with various delimiters as described in the reference.

I don't know how yet, but there should be regex or list with next options:

• // - Simple comment
• /// - Outer line doc (exactly 3 slashes)
• //! - Inner line doc
• /*! - Inner line doc
• /** - Outer block doc (exactly) 2 asterisks

Firstly, please, disable //! for Rust because it's horrible when standard docs looks like attention like XXX or FIXME.

Unit tests for parser.ts and extension.ts need to be started

Add a tags key (containing an array of strings) to allow for matching multiple, synonymous tags with a single set of styles.

Sometimes we need to put date/time info into comment section. It'd be very handy to have a command to insert such info automatically using this extension. The date and time format can be configured through settings.

Thank you.

Please add provisions for multi-line PowerShell comment blocks.
Multi-line comment blocks in PowerShell begin with <# and end with #>.

Please see this thread for background.

Added FR as per @aaron-bond

Expected object instead of array.

"better-comments.tags": [
{
"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
}
],

Add a setting to toggle highlighting of pre-comment whitespace.
better-comments.highlightPreComment: true | false defaults true

Which is currently how it is handled.

Hi Aaron,

This should be a really quick and simple change... thank you so much for the help!

The source for hive-sql extension: https://github.com/JoBrad/hive-sql-vscode/blob/fcfa3bdc92cbb3357edffb1d3efc83d39160b907/package.json#L34

Just a request to support Terraform syntax :)

The extension fails to render comments correctly after switching to unsupported file types such as .gitignore file or a plain text file. Is this a known bug?

Bug evidence:

Workaroud:
Restart VS Code and never open any files that are not supported by this extension while you need to use this extension.

Info:
– extension v.1.2.0
– vscode v.1.21
– macOS v.10.11

Please, add support for JSON with comment (jsonc) files.

Thank you.

please support multi root workspace

when I set : "editor.renderWhitespace": "all", whitespace in comment will be colored by this plugin.

help me！

Please, add support for object pascal (modern pascal) programming language.

The comment syntaxes in object pascal are:

• line comment: //
• block comment:
  • {…}
  • (*…*)

Can you just add an option to make this extension works on any kinds of file? By simply using the given tags. So everyone could use this extension on any languages that haven't yet supported, while waiting for official support.

Thank you.

Can you please add support for AL language?

The syntax for comments are as follow:

• line comment: //
• block comment: /* */

AL files end with the .al file extension.

Many thanks for your great extension and your great job!

Salut!
Laura Nicolàs

The TODO highlighting works for single line comments with a colon, i.e:

// TODO: Something something...

But doesn't work for multiline comments, i.e:

/*
TODO: Something something...
*/

I don't have time to make a pull request at the moment though, sorry!

Currently, this extension only supports color and strikethrough options. Could you please add more font style options for comment tag?

Here's some other font style options that can be provided:

• bold
• italic
• underline
• font size
• font family

Thank you.

Sometimes it works, then it stops working for no reason and it stays like this, only way i to get it back is to keep reloading, disabling and enabling shit, until it eventually pops back again when it feels like it.

this is my code from user settings

    "better-comments.multilineComments": true, 
    "better-comments.tags": [
        {
            "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
        }
    ],

The extension works for me on most languages except .scss files. I can't seem to figure out why. I did check the extension log that shows extensions being loaded and I didn't see it load but IDK if that means anything. PLEASE HELP!!!!

Could you please add some settings to let us define custom comment marks? My proposal is:

• add a section to define block comment syntax, for example:
  "block comment": {
  "start mark": "(*"
  "stop mark": "*)"
}
• add an option to define (single) line comment syntax, for example:
  "line comment mark": "//"
• add an option to toggle this custom comment feature, for example:
  "custom comment": true

These custom comment marks settings would only work if the language isn't recognized by the extension. Otherwise the extension would use the official language comment syntax. This way would enable user to use this extension for any kinds of programming languages that haven't yet supported, until they are supported officially.

Thank you.

Just updated to the latest version of this extension, v.1.2.0. And I got some enhancement ideas.

The new striked text feature is very useful. However, there's a little glitch that makes it look imperfect when it's used within the jsdoc section. It's the starting point of the striked text. Instead of starting from the beginning of line, could you make it to start from the asterisk? Like it's shown at the line number 33 that starts from the //.

Screenshot attached, the glitch is shown at the line number 16 (I changed // to -).

Screenshot:

Would it be possible to simply add the ability for us to tell Better Comments which comment tag to search for? This would allow us to configure the extension to work with many other languages such as Python or Lua.

I want to change it from registering // as a comment, to -- to work with SQL and Lua Scripts.
So that I can do: -- TODO: This needs completing!

I'm currently using Visual Studio Code and no option like this exists (you can only change colours).

Thanks for the great extension. I've recommended it to every developer I work with and they love it too!

I have forgotten how to use this extension ? :)

Hello, is possible to change the font size for a particular tag? This would help in better comment for the code sections - I now use ASCII art, but it would be better to tag a specific line of comment (which would also result in a change in font size).

P.S. great extension.

Is this package going to support Python comments? #

Great extension. I use it daily. What I would like to see is support for text file (.txt) with simplified tagging. Reading the first character and utilizing that (+,?,TODO, etc.) without having to do // or comment block to trigger text formatting.

When opening up vscode, comment colors are not showing. If i swap my language detection from Javascript React just to Javascript, it begins to work again.

Rationale: Allow those who follow JSDoc or similar documentation conventions, @ to have highlighting.

Current:

• Alert: !
• Queries: ?
• Todo: TODO
• Removed: ////
• Description: (none?)

Proposed: (defaults written in)

better-comments.annotations: {
  alert: ['!'],
  queries: ['?'],
  todo: ['TODO'],
  removed: ['////'],
  description: [' '],
}

I suggest an array so that if people want to have multiple annotations be highlighted identically, such as both ['TODO', '@todo', '@todo'], it'll be feasible.

I'd like to propose a new feature. It's a common practice in coding that inside a comment we need to point a specific position in the source code to explain something. For example, this comment

// the code block below is similar to a code block @123,5

would render @123,5 like a link (underlined). If it's clicked, the cursor will jump to line 123 column 5. If the column value is omitted, the default value is 1 (first column). It's like a shortcut for go to line command. Doing an undo (or go back?) would bring the cursor back into the previous location.

It'd be great if it's able to jump into another file. For cross file jump, the syntax should be filename.ext@line[,column]. For example: test.pas@10,5 would jump to test.pas file at line 10 column 5.

Is this kind of feature possible to be implemented? What do you think?

Thank you.

As discussed in #8 python uses docstrings for block comments like so:

"""
my_method does a thing. There are many like it, but this one is mine.
? Do we really need this?
! Deprecated
@param my_param Do some stuff with this
"""
def my_method(my_param):
    ...stuff goes here...

It would be nice to have Better Comments work for that as well.

Some people put spaces before their text in those docstrings:

"""
    my_method does a thing. There are many like it, but this one is mine.
    ? Do we really need this?
    ! Deprecated
    @param my_param Do some stuff with this
"""
def my_method(my_param):
    ...stuff goes here...

Hi @aaron-bond - how could I go about adding support for MATLAB? I'll make the changes and send in a PR.

I'm not sure how much this would be to add, but it would be nice to allow block comments without stars in front of them to have the highlighting. Like this style:

The options to put the tags right after the /* to make the entire block comment highlighted would be handy as well, to add a strikethrough to an entire block of code or allow multiline todos

At present, having a "doc block"-style multi-line comment produces the following:

While this is "okay", it's not desirable to have all these lines highlighted. Ideally, it should look more like this:

Hi! It would be great if your extension could support VB and VBScript comment. Both use a single quote (ex: ') to start a line comment and there's no block comment. Thanks!

The issue pertains to @moduledoc in Elixir.

@moduledoc """"
Some description
    !This does not work
"""

A normal comment #! some comment works fine.
I can also get moduledoc to be working if inside the triple quotes I add a # comment symbol with a tag:

@moduledoc """"
Some description
    # !This does work but now I will have to go through 500 files and adjust accordingly.
"""

Is it plausible to add support for tags to be working within moduledoc?

Rust uses it for module documentation eg:

//! This library multiplies numbers

/*!
This is a multiline module doc comment
*/

fn mul(a: u8, b: u8) -> u8 { a * b }

I was hoping tags for comments could be added; though the command palette you could search the tag for the severity of the comment. For example one comment would have a tag of; maybe. When searching for tags if there is more then one comment with the tag of, maybe you can quickly view them ?

Just updated to the latest version of this extension, v.1.2.0. And I found some bugs.

The @param of jsdoc feature isn't working, at least with pascal source file. Screenshot attached, the bug is shown at the line number 18.

Screenshot:

What format do you use to achieve the effect of having @param in one color followed by the parameter in a different color and then the rest of the line in the default color?

See image:

I would prefer not to add TODO on the next line because other tools could count that as an additional todo when it's in fact the same as the first.

I commonly put a tab after my comment delimiter and surprised this is not supported.

Is there any problem if there would be a tab between the delimiter and the comment?

I'm using this extension with markdown file for months ,
it works great!
but suddenly it didn't work!?
any idea?

Many scripting languages start their file with a shebang to indicate which interpreter should be used (i.e. python3 scripts have #!/usr/bin/env python3). By default this is picked up as an important comment and the color is changed incorrectly.

As the shebang always starts #! and is on the first line, it should be possible to exclude comments from highlighting if they start with a #! and are on the 1st line of a file.

just as the title