Possibility to disable comment suggestion?

[lehtiniemi]

This product is really incredible. The one thing I would like to have is the ability to disable these two behaviors upon will:
-disable comment auto-complete - I like to write my comments myself and a suggestion that appears on screen distracts the thought process because I automatically read it
-disable suggestion of functions when nothing is being typed. I find that when I'm inside a class between methods, CoPilot starts suggestion full methods without nothing being typed. I don't want this because I constantly have to hit esc to stop suggestions. Please see the attachment. This sometimes happen, sometimes not (don't know the reason yet).

Both are related to CoPilot trying too much and this requires my constant attention and becomes a distraction.

But I really like the method and code line autocomplete, they save a ton of time so just some checkboxes to limit the feature functionality would be nice.

[jaquinocode]

Just chiming in to say that the only gripe I have with Copilot is that inline suggestions show while I'm writing a comment. It distracts my thought process and slows me down significantly.

Without that issue, Copilot is game-breaking. But with that issue, it's kind of a double-edged sword in terms of improving your productivity.

[jaquinocode]

Here's a workaround I figured out for how to fix the comment suggestions problem! 🚀

The basic idea is to create a keyboard shortcut that we press in order to disable the inline suggestions from popping up. So before we write a comment, we can just press the keyboard shortcut to disable suggestions, then write the comment, and then press the keyboard shortcut to enable suggestions again. It's not a perfect solution, but it works!

To do this:

1. Install the Toggle extension.
   • (It's written by a vscode contributor and enables you to toggle settings with keyboard shortcuts. We need to do this because the Copilot extension doesn't actually provide a keyboard shortcut to disable inline suggestions.)
2. To your keybindings file for vscode, add the keyboard shortcut snippet below. You only need to change the values for key in order to have it work. (As of the time this comment was written, github.copilot.inlineSuggest.enable is the setting we need to toggle here. If they ever change that setting name in the future you'd have to change the below snippet accordingly.)

{
    "key": "shift+cmd+c",  // set this to whatever works for you
    "command": "toggle",
    // By the way, this "when" expression was inspired from the "when" expression for Copilot
    // extension's "Trigger Inline Suggestions" keyboard shortcut.
    "when": "editorTextFocus && !editorHasSelection",
    "args": {
      // This id is just a unique name you come up with yourself
      "id": "toggleGithubCopilotInlineSuggestionsBeingEnabled",
      // The names and values of the setting you want to toggle. In this case, it's to enable/disable the
      // `github.copilot.inlineSuggest.enable` setting.
      "value": [
        {
          "github.copilot.inlineSuggest.enable": true
        },
        {
          "github.copilot.inlineSuggest.enable": false
        }
      ]
    }
},

For more info on how to setup a toggle keyboard shortcut you can look at the extension page for the Toggle extension. You can also read more info about it here.

3. Press the keyboard shortcut you set up and notice that the corresponding setting in vscode's settings file changes in response. Cool, you're done!

Note: This will allow you to disable inline suggestions from showing up. But it won't make a current inline suggestion, that's already showing, vanish. Just press Esc in that situation if it ever comes up. Ideally, you'd disable inline suggestions ahead of time before they'll pop up. That way you'll never have to press Esc.

[darajava]

This is not a solution

[alex-calderwood]

I do something similar to this but I did it without a template since I never mess with the settings.json. You can just bind a hotkey to toggling the completions using the UI.

I think this is the best short-term fix, but I wish it would automatically detect whether we are in a comment (for whatever language) and not serve a completion.

However, there are some problems with this request - there are a few times that I want it to write documentation for me... so this temporary solution of manually turning off/on completions actually handles that pretty well.

[b-hayes]

Rather just never get suggestions inside comments then to have to keep turning it on and off.

[jaquinocode]

Github Copilot extension contributors, if you were to provide a keyboard shortcut to toggle enabling inline suggestions then the above instructions wouldn't be needed. I highly suggest you provide one!

[jamesonknutson]

@jaquinocode @lehtiniemi

I too got tired of copilot throwing suggestions in my face and breaking up my mental flow, so I wrote a VSCode extension that makes Copilot STFU when you're writing comments. It might be a better solution than your hotkey fix @jaquinocode

[steinhh]

But is it possible to configure this to prevent comment suggestions at all? Copilot often suggests "//" after the end of a statement, i.e. "would you like to write some comment about what this line does". But that's not how you should write code ;-).

I've tried adding "\;" to the inhibitMatchers setting, but it seems not to work, am I just doing something wrong?

[sergiotasconmorales]

Very useful. I was tired of copilot trying to (unsuccessfully) read my mind every time I tried to write a comment :'D Thanks @jamesonknutson

[ryanberckmans]

great extension, thanks.

[jarrodwhitley]

Anyone out there capable and willing to make a similar plugin for PhpStorm?

[ErikRossRonnow]

you're goated bro thanks, just what i was looking for aswell, so cringe when it autocompletes a comment and you completely lose your train of thought! <3

[verhovsky]

Instead of just disabling comments suggestions it could be better to increase the threshold of confidence required to show the suggestion when you detect that the suggestion is entirely commented out text, because when Copilot completes a long variable names in a comment is useful.

[JoannaFalkowska]

I would love to see this feature. In 99% cases the comment suggestions are incredibly disruptive, useless and annoying. In the remaining 1% they're still disruptive and useless, but at least they're so absurd they become funny.

[sudara]

This is my #1 feature request. We should be able to disable comments.

When writing a comment, I have the "intent to clarify." There's 0 cases out of hundreds where Copilot correctly guessed this intent (IMO this isn't possible by definition), so it's either a source of amusement or noise, and devalues what it's actually good at.

[iandunn]

I have exactly the same problem. I think I'm gonna disable CoPilot because these are so distracting and happen so often. It far outweighs the number of times it suggests a useful line of code.

[steinhh]

And as someone pointed out somewhere else: If your code is so clearly written that an artificial intelligence is able to write your comment,, a human intelligence will be able to understand your code as well: ergo, the comment is not needed and should not exist!

[StephenHaney]

Big +1... the comment suggestions are hilariously wrong and really distracting. I haven't had a single one that's even related to what I want to actually write. And my brain auto-reads whatever pops up, which hijacks my thought process. I'd love the ability to disable inline suggestions for all comment blocks. I'm disabling copilot for now until this is supported.

[jamesonknutson]

I'm not sure if you're using Jetbrains or some other similarly-not-vscode editor, but I just updated my extension I wrote (referenced above) to allow user configuration of the scopes where Copilot's suggestions should be disabled, in case that fixes your issue.

[haszari]

It's like a teenager, constantly interrupting your thoughts!

[floer32]

I'd really like to disable comments-completion in JetBrains editors as well.

[tbenthompson]

+1 on this. Very distracting. Is providing an option here on a roadmap anywhere? I like Copilot enough to keep it enabled but I find myself looking away from the computer screen while I type longer comments!! I guess it's good typing accuracy practice.

[aaroncrawford]

This is single-handedly keeping me from buying copilot. I comment a lot and this breaks my flow entirely.

[sergiotasconmorales]

For me the extension by @jamesonknutson has been useful as a temporary solution. Now I don't get any suggestions for comments

[ryanjsalva]

Thanks for the feedback, y'all. What I'm hearing is:

• Problem: Copilot is too "chatty" when the developer is writing code comments
• Workarounds: To cut-down on the noise, a few folks have used other extensions to toggle Copilot on/off via keyboard shortcuts
• Ask: Build some gesture into the Copilot extension that reduces noise when writing code comments

[aaroncrawford]

I'd also prefer disabling it for comments entirely.

[sudara]

+1 to complete disabling, I'd rewrite the ask like so:

Ask: Add a feature toggle to the VSCode, Jetbrains and other Copilot integrations to never autocomplete when in a comments context.

[xvdp]

I agree with everyone about thought process disruption. I would also like to be able to toggle copilot altogether sometimes.

• Comments off most often please. The only time when I find them useful is when I have a whole bunch of classes already done so it may copy my syntax for Args perhaps.

• Toggle copilot on and off completely

• For example Im writing a skeleton class, or Im writing something I know very well how to and I like my coding style- I prefer to just go.

Maybe this could be implemented like pylint mutes e.g. (i dont like digging settings, I dont like key shortcuts)
#pylint: disable=no-member
something like?
#copilot: disable=comments
#copilot: disable=this-class

[xvdp]

Addendum to my comment. Copilot keeps trying to get me to do code that I don't want.
It is super useful in the case when I'm trying to do something that im not completely familiar - for instance, if I'm writing some code to do with camera calibration and I don't remember the distortion parameters; or in the typical standard libraries where which one doesn't exactly remember order of args or name of kwargs

• Disable extension ( I'm in 'nightly' and the latest vscode) DOES NOT WORK - it keeps suggesting stuff.
  I would program mostly on disable mode, then enable it when I'm groping.

• or extending my pylint syntax analogy: perhaps a simpler switch syntax. eg. Disabling globally and locally enabling - inside a function, class or file
  #copilot: enable #to enable in this project, file, class, function, perhaps overriding a prior
  #copilot: disable #same as above

[d2x]

I too would like the ability to disable comment auto-completion in JetBrains IDEs completely. It's great if it wants to suggest a block of code based on comments, but the comments are meant to be for my own use when mapping out workflows that need to be achieved. Even prefixing them as // TODO: doesn't stop it from suggesting things which then breaks concentration.

+1 for Ask: Add a feature toggle to the VSCode, Jetbrains and other Copilot integrations to never autocomplete when in a comments context.

[ewhitesides]

perhaps copilot could be set so if you start the line double comment chars (for example ## instead of just #), copilot would know not to suggest anything? that would allow for in-the-moment disabling without having to start/stop the extension.

[joliss]

I do occasionally have situations where Copilot produces useful completions in comments, so I don't want to completely disable it in comments. But I agree with the original poster that it's distractingly noisy at the moment.

So I think that ideally, Copilot would suggest completions in comments only when it's reasonably sure about them.

[jesseconnr]

This really needs to be an option. I just started trialing Copilot and I've already had to disable inline autocompletion on everything solely because of the distraction it causes when autocompleting comments. The existing workarounds aren't great for a paid product.

[aaroncrawford]

Can we get an explanation why this is either A) difficult to implement or B) not seen as an important option?

Copilot has been great except the comment suggestions. My team comments a lot and this breaks flow entirely. The success rate is probably 1%. We'd much rather be in charge of comments, then have Copilot attempt to create the line/block based on our comments rather than it just wildly guessing at what we're attempting to do.

[ToM-Korn]

I found a quick workaround for myself... Maybe it helps someone else as well.

1. I just put (in python) another # at the end of the line.
2. Put the Cursor in front of it
3. Then write my comment between the two ##

# I write a comment#

Copilot does not write comments if you are in the middle of the text

[koynoyno]

Awesome advice. Thank you.

[iandunn]

If GH doesn't want to allow completely disable the processing of comments, then as a compromise they could add a option so that they're only processed with a prefix.

This comment would be processed:

// copilot loop through the response and create a DOM element for each item, then append it to the container

This comment wouldn't be processed:

// todo refactor this after launch

That'd work similar to how ok google or alexa only respond when explicitly prompted.

[steinhh]

The disable-copilot-comment-completion plugin works quite well!

The only confusing thing is that it changes the .vscode/settings.json file to set "github.copilot.inlineSuggest.enable": false whenever you're in a comment. Then it changes back when you're in a piece of code. (I guess it's VSCode itself that changes the file, as a result of the setting being toggled)

[ablegrape]

Also good to remember that VSCode isn't the only platform for Copilot. (There's IntelliJ IDEA, for example.) Unless there are plugins for every platform, it would be much better for the comment completion disabling to be part of Copilot itself.

[AuthorOfTheSurf]

2024 —

There is a certain Zen to finding the right moment to comment, and writing a quality comment that truly serves its purpose

The constant auto-suggested comment text is driving me crazy because CoPilot is wrong regarding comments 99% of the time

Business context, nuance, and precise control of ordering and level of detail is required for comments to have their intended impact

I use WebStorm (same as IntelliJ) by JetBrains, so VSCode-specific solutions do not work for me

[ethel-dev]

This is wrong how long it has taken to address something as silly as this... VSCode user for years... Let humans turn off the AI's annotation of the code. We use AI to write tedious code that people have done millions of times, not to understand and intuit purposes that the AI almost always knows very little about. The AI cannot understand the assignment right now like a human can.

[gregb-jobber]

+1. The comment suggestions completely break my thought process and they're not as helpful as the code suggestions.

Also some times it start the comment with // This is a hack ... and I feel attacked. 😆

[chreekat]

I use https://github.com/github/copilot.vim. The inability to disable comment suggestions made Copilot pretty frustrating. Luckily, I was just able to figure this out. I haven't messed with it much but it seems to help:

diff --git a/autoload/copilot.vim b/autoload/copilot.vim
index 0236325..c623233 100644
--- a/autoload/copilot.vim
+++ b/autoload/copilot.vim
@@ -408,6 +408,15 @@ function! copilot#IsMapped() abort
 endfunction

 function! copilot#Schedule(...) abort
+  " Only fire if not in a comment. Have to step back one column -- see note at
+  " :help synID().
+  " Caveat 1: Copilot will still fire if the cursor is on a blank line. -_-
+  " Caveat 2: "[synID] can be very slow."
+  let synName = synIDattr(synIDtrans(synID(line("."),max([1,col(".")-1]),1)),"name")
+  if synName ==# "Comment"
+    call copilot#Clear()
+    return
+  endif
   if !s:has_ghost_text || !copilot#Enabled() || !copilot#IsMapped()
     call copilot#Clear()
     return

[svermeulen]

This didn't work for me. I also tried a few more variations of this to no avail, so just used this terrible hack instead:

diff --git a/autoload/copilot.vim b/autoload/copilot.vim
index 782183f..0a91580 100644
--- a/autoload/copilot.vim
+++ b/autoload/copilot.vim
@@ -405,8 +405,24 @@ function! s:Trigger(bufnr, timer) abort
   return copilot#Suggest()
 endfunction
 
+lua << EOF
+function copilot_vim_is_on_comment()
+    local current_line = vim.fn.getline('.')
+    local filetype = vim.bo.filetype
+
+    if filetype == "lua" then
+        return current_line:match("^%s*%-%-") ~= nil
+    elseif filetype == "cs" then
+        return current_line:match("^%s*//") ~= nil
+    end
+    -- TODO add more filetypes
+
+    return false
+end
+EOF
+
 function! copilot#Schedule() abort
-  if !s:has_ghost_text || !s:Running() || !copilot#Enabled()
+  if !s:has_ghost_text || !s:Running() || !copilot#Enabled() || v:lua.copilot_vim_is_on_comment()
     call copilot#Clear()
     return
   endif

[davjs]

@ryanjsalva It's 2024 and this issue remains unresolved.

I can only assume the delay for fixing this is due to expectations that Copilot will over time provide more helpful comments.

However, it's important to note that the concern isn't solely about verbosity but rather about accuracy in understanding user intent.
When users provide comments, they often do so to convey context beyond what can be inferred directly from the surrounding code.
This context is not yet accesible to the AI and it will likely be a long time until it can be inferred. Until this time comes (if it ever does) I propose you get of your high horses and make a practical fix for this issue. That way us who like reap the benefits of github copilot while maintining high quality comments can do so without disruption.

// Unsubscribing yet again

[duc2019]

I disabled copilot due to this issue despite my company purchased the enterprise license.
I assume copilot is only for noobs that they can't even write their own word down.
Good engineers able to write comments themself is not likely to use copilot, I think this is the reason they keep this issue open for 3 years.

[ablegrape]

Kinda nuts that 3 years on, this issue, which is by far my number 1 gripe with Copilot, and sounds like it is for many others, is still not only unresolved, but hasn't had any comments or acknowledgment from the Github team in more than a year and a half (and thank you, @ryanjsalva, for that, when you did). It would be nice to have some kind of idea of whether this is even on the radar, and if so, for what kind of schedule.

[peabnuts123]

For those struggling with this, I personally have found the keybind GitHub Copilot: Enable/Disable Copilot completions (github.copilot.toggleCopilot) a solid workaround for this. I toggle copilot on/off all day (not just due to comments). I think that's a sensible use of a tool. You don't want to use it for everything all the time. I would still love a setting to outright disable it suggesting while you are in a comment block, but using the shortcut to turn it on/off is an acceptable workaround IMO.

[FacioRatio]

Just throwing my voice into the wind. The day an AI can write a comment for me is the day I'm obsolete, so I'll never need this distracting feature. Attention is the only currency.

[cwoodhayes]

+1 pls @ryanjsalva

[wwaugh-intel]

This has been bothering me too, so my first thought was to ask Copilot about itself before resorting to a web search. So I ask Copilot Chat "How can I disable Copilot comment suggestions while retaining other functionality?"

According to Copilot:

You can disable just the comment suggestions feature of GitHub Copilot without turning off the entire extension. To do this, follow these steps:

1. Open Visual Studio Code.
2. Go to the settings by clicking on the gear icon in the lower-left corner and selecting "Settings," or press Ctrl+,.
3. In the search bar at the top of the Settings pane, type "Copilot".
4. Look for the setting named "GitHub Copilot: Enable Comment Completions" and uncheck it.
   Alternatively, you can add the following setting to your settings.json file to disable only the comment suggestions:

{
    "github.copilot.enableCommentCompletions": false
}

This will disable GitHub Copilot comment suggestions while keeping other features enabled.

Of course, this is pure hallucination (there is no gear in the lower left, and no such setting exists), but it's offered with such confidence!

[steinhh]

It says it as it should have been... thanks for the report!

[peabnuts123]

There should be a cog in the bottom left of your screen … ? That's where settings is 🤔

[wwaugh-intel]

There should be a cog in the bottom left of your screen … ? That's where settings is 🤔

Take a look at this screenshot, where do you see the cog?

[peabnuts123]

It looks like maybe the size of your editor or an extension / setting / something has collapsed your sidebar to a horizontal list of tabs above the word "Explorer". The cog in your screenshot is in the top-right, next to minimize et al.

My vscode looks like this, by default: