bug#60805: [PATCH] Extend go-ts-mode with command to add docstring to function

[Theodor Thornhill]

Eli Zaretskii <eliz@gnu.org> writes:

>> Cc: Randy Taylor <dev@rjt.dev>
>> From: Evgeni Kolev <evgenysw@gmail.com>
>> Date: Sat, 14 Jan 2023 08:45:31 +0200
>> 
>> [CC Randy Taylor, author of go-ts-mode]
>> 
>> This patch extends go-ts-mode with a command to add docstring to
>> current function. If a comment already exists, the point is instead
>> moved to the top-most comment line.
>
> Thanks.  When accepted, this should go to the master branch, as it's a
> new feature.
>
>> First test, with this input, point inside the function body.
>> ```
>> func test1(a, b int) int {
>>     return a + b
>> }
>> ```
>> 
>> Pressing C-c C-d results in:
>> ```
>> // test1
>> func test1(a, b int) int {
>>     return a + b
>> }
>> ```
>
> Is this really the best Emacs can do to produce such a comment?  It's
> not a very useful comment, is it?  I understand that the user is then
> expected to add some more meaningful text to make the comment useful,
> but I'm asking whether Emacs could collect more information about the
> function, and provide a skeleton of a useful doc comment for the user
> to fill.
>
> What do other IDEs do for this kind of functionality?
>
>>     Extend go-ts-mode with command to add docstring to function
>> 
>>     go-ts-mode is extended with command go-ts-mode-docstring which adds
>>     docstring comment to the defun at point. If a comment already exists,
>                                              ^^
> Please observe our convention of leaving 2 spaces between sentences.
>
>> +(defun go-ts-mode-docstring ()
>> +    "Add docstring for the current function if it does not
>> +exists. Otherwise, jump to it."
>
> The first line of a doc string should be a complete sentence.
>
> Finally, this change needs a NEWS entry.


Should we maybe generalize this into something all *-ts-modes can use?

Maybe it also could support some syntax to be used by for example
yasnippet?  There are examples on how to do so in eglot.el, if I'm not
mistaken.

Theo