How to use @param and all @ arguments in comments?

Help and Feedback Scripting Support
#1

I havent seen a proper documentation on this one, does anybody know how to use them properly?

#2

This is done in order to write self-documenting code. I guess it’s a simple prefix, nothing more.

#3

If youre still looking for an answer i assume you mean something like this?

--[=[
    @param Player Player -- The player object
    @param ID number -- Gamepass
    @return boolean -- Returns true or false if owned
]=]
function LibraryYoda:GamepassOwnership(Player: Player, ID: number):boolean
	return MarketPlaceService:UserOwnsGamePassAsync(Player.UserId, ID)
end

Where calling this function would show the params it takes and the return value as a comment

1 Like