Sorry for terrifying you when you use a type annotation
this post was submitted on 04 Aug 2024
197 points (100.0% liked)
Programmer Humor
421 readers
44 users here now
Welcome to Programmer Humor!
This is a place where you can post jokes, memes, humor, etc. related to programming!
For sharing awful code theres also Programming Horror.
Rules
- Keep content in english
- No advertisements
- Posts must be related to programming or programmer topics
founded 1 year ago
MODERATORS
Incredible
"Still no girlfriend? When marriage? When grandchildren? Marry her, she's a doctor!"
Shut up! I swear I'm switching to Emacs if you don't stop!
Somewhere in the world, somebody can look at this and truthfully say "she's my type."
Can someone please explain? What would cause VS Code to show an image like this? Is this related to a plugin? (I don't know what a docstring is)
A docstring is a comment that is used to annotate types/methods/classes/whatever and can be parsed by the IDE and used to provide various hints/assistance when writing code. Tooltips, parameter type suggestions, intellisense, etc. for things that aren't native parts of the language all usually come from or can be supplemented by docstrings.
The specific format of a docstring varies by language, but many of them prefix meaningful tokens with an @, like @type or @param.
However, if your project is using GitHub it's also quite common to mention users in comments by prefixing their username with an @, so several vscode GitHub extensions will make any "@{real username}" in a comment into a link to that user, which will show a small user tooltip when hovered.
Edit: I appear to have conflated docstrings and docblocks, but then so has the initial post. I guess at some point "docstring" has just taken over to colloquially refer to all of it.