Enhanced docstring capability

[mobynet1]

I have found a way to get codiumate to generate docstrings in a given format which I have stored in a separate file, but the process does not persist across editing sessions in Visual Studio Code and is largely a pain in the ***.

I have a file I call func-docstring.template which details the format I desire:

/**
 * [function-name] - [function-description]
 *
 * Parameters:
 * - [p1-name] [p1-type]: [p1-usage-description]
 * - [p2-name] [p2-type]: [p2-usage-description]
 * - ...
 * - [pn-name] [pn-type]: [pn-usage-description]
 *
 * Returns:
 * - [return-name] [return-type]
 *
 * Errors:
 * - [error-name] [error-description]
 *
 * Description:
 * [function-description]
 *
 * Example:
 * [function-call-example]
 */

I select this text and add it to the context. Then, I select the entire function I want to generate the docstring for. Lastly, I tell codiumate to generate the docstring which it does correctly about 90% of the time. Sometimes it will do it correctly, sometimes it will use /* ... */ instead of /** ... */, and yet other times it will double slash the line //. Why it would be different between docstring requests is a mystery to me. The template should drive the format. The reason why /** is useful is because it will allow the folding of this comment section so it can be 'hidden' if desired.

Here is what would make my life easier: Allow users to create a docstring template that will be used every time a docstring is generated. There may even be different contexts where different templates could be used such as funcs, types, inline, or some other level, so let the user define the template for each type. A given template should be different based on the language being used. In my case it is Golang. The comment line length should be defined so that comments will automatically wrap if over the length limit.

If I click on the function name, right-click to get the context menu, and select Codiumate->Write Docstring for this code, this should generate the docstring in this custom, templated format. I do not want to have to select the whole function to complete this task. If it finds the cursor over a function name, then use all the lines in the function as the context. As it stands now, Codiumate is not smart enough to see what was selected (nothing in this case) and examine where the cursor is. When no code is selected, it will respond with "Please select the code you want to process and try again, or choose a component in the bottom right corner." which is a disappointment. This process could be a whole lot simpler.

Hopefully others will find value in this enhancement, too.

Cheers,
Steve Miller