Hello developpers!

If you start typing the name of built-in function, the code editor will display to you what does the function do (something like this)

So, how do I describe my own functions in the similar way?

you canot make description but you can make description after the argument smt like this

```
local function test(test :"What You Type Here Get Printed")
print(test)
end
test("A")
```

you can make : after an argument and you can type a string and it will get suggested

1 Like

What you’re asking is part of the studio. For the studio’s use.

You can always do this …

```
-- Adds two numbers and returns the result.
-- @param a number The first number to add.
-- @param b number The second number to add.
-- @return number The sum of the two numbers.
function add(a, b)
return a + b
end
- OR this
function add(a, b)
--[[ Adds two numbers and returns the result.
@param a number The first number to add.
@param b number The second number to add.
@return number The sum of the two numbers. ]]
return a + b
end
```

I forgot about this … stubbled on it trying to set up function defaults. Once you have a function made, when you start to type it out it will show the variables used like that.

This topic was automatically closed 14 days after the last reply. New replies are no longer allowed.