Is there a name for the type of comments agents add where they leak the prompt?

  • Posted 4 hours ago by xdennis
  • 10 points
This is a stupid example to illustrate what I mean. Say you have this code:

   def create_background(width: int, height: int) -> Image:
       ...
You tell the agent to use default values for create_background, the same as in create_screen. It changes the code to:

   # Now create_background params have default values, the same as create_screen in screen.py
   def create_background(width: int = DEFAULT_WIDTH, height: int = DEFAULT_HEIGHT) -> Image:
       ...
The unnecessary comment is a staple of vibed code, but the tone also annoys me because it leaves behind the prompt. It words comments based on what it was asked to do, not in a timeless manner.

I keep telling people in code reviews to remove unnecessary comments, and I feel I lack the vocabulary to express why this is bad.

4 comments

    Loading..
    Loading..
    Loading..
    Loading..