How to Properly Comment Functions in Monkey C Using VS Code

Is there a way in VS Code to add a comment or documentation to a function so that it appears as a tooltip or suggestion when using the function elsewhere in the code?

I've tried some common documentation formats, but haven’t been able to get it working.

For example, I tried this:

/*!
 * Constructor
 * @param item - the menu item to be associated with this command
 */

But the comment doesn't show up when I type the function name elsewhere. Is there a specific format or extension required to enable this?

0 FlowState 2 months ago

I think Monkey C only supports one source code documentation style: C++-style comment with "!" suffix (i.e. "//!")

//!
//! Constructor
//! @param item - the menu item to be associated with this command
//!
function initialize() {
    // hello
}

All of the SDK samples use this documentation style (and the projects contain corresponding HTML documentation which was apparently generated from the source.)

0 the-ninth 2 months ago in reply to FlowState

FlowState said:
I think Monkey C only supports one source code documentation style: C++-style comment with "!" suffix (i.e. "//!")

I gave it a try, but I wasn’t able to get tooltips to show in VS Code using this approach. That said, ever since SDK 8, I’ve been getting frequent error notifications in VS Code, so it’s possible that tooltips just aren’t working properly at the moment.

0 FlowState 2 months ago in reply to the-ninth

Does your project build without errors? Unfortunately, like a lot of Monkey C IDE language features, it looks like documentation tooltips don't work unless you project builds without errors.

0 the-ninth 2 months ago in reply to FlowState

Yes, it does. and I also tried buiding with the comment to see if it works after that, but it didn't.