doc-comments

[Rudxain]

What is the problem this feature will solve?

Make symbol documentation more accessible/available

What is the feature you are proposing to solve the problem?

Be able to hover on a symbol reference and see the comments at its definition.

For the comments to be visible on hover, they could be required to have a special format. Examples:

• JSDoc requires block-comments with an extra star /** */
• LuaLS an extra hypen
• Python """ """ inside defs
• Rust ///
• etc...

I've also seen C lang-servers that just accept any comment, regardless of format, so long as it's immediately at the top of a function declaration.

Bash-Completion uses @param:

# commit cdc3456016e6b8bf224218b6c14e73fb8ab6b3ab
$ grep -rFl '@param'
test/config/bashrc
completions/make
completions/apt-cache
completions/ssh
completions/mutt
completions/tmux
completions/cvs
completions/lvm
bash_completion
bash_completion.d/000_bash_completion_compat.bash

Related: #1233

What alternatives have you considered?

User could just go-to-definition, but then they have to go back to where they were