SkEditorTeam/SkEditor

[SUGGESTION] Skriptdocs

Opened this issue · 4 comments

Add skriptdocs system like the java docs, in java you can do

/**
 * Description of code
 * @param name The name of the animal
*/
public static void dog(String name) {}

Add this to skript editor so it reads them and color them, and when you hover it shows what the function does and what parameters it requires as this

##
# Description
# @param player The player you want
# @return Return the player name
##
function getName(p:player) :: string:
  return {_p}'s name

Thanks for your suggestion!

That's already planned. If I remember correctly, @GliczDev wants to add this into the Analyzer.

Hmm, I think I was wrong, he only mentioned that it could be a separate addon.

So yeah, I'll probably start working on it.

And can you please make it when you type like triple # or double or something so it puts them auto then you type the params description and description of function and return type

And can you please make it when you type like triple # or double or something so it puts them auto then you type the params description and description of function and return type

Yeah, I want to add it