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.
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
@typeor@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.