Help with comments

[trim hearth]

So i recently try to apply for scripter on the hidden devs server and i got rejected for my comments , can someone explain to me how to do them, https://pastebin.com/vYmLVsGX

[lean crow]

idk im not using commands, but goodluck finding someone who does

But I think AI could help you with that tbf @trim hearth

[trim hearth]

it probably doesnt even understand what it does

[lean crow]

Either you underestimate AI or you simply don't know how to use it

[real kraken]

AI WILL BE GOD !

[long mason]

@trim hearth comments should be short and Sweet, think of them as reminders to yourself and quick explanations

They shouldn't be a paragraph or two long

[white carbon]

comments look like you're teaching someone how it works, i'd assume the people ranking it already knows what they are looking at.

[flat comet]

you dont need comments that are more than 2-3 lines long, you also shouldnt need comments inside functions unless the logic is confusing.

comments above functions should ideally explain the params and what it returns which you can use tags for such as @param or @return

[long mason]

@trim hearth basically what we're all saying is you wrote API documentation for your code inside of your code not comments

[trim hearth]

Thanks guys, ive never worked with someone before so writing comments was never important to me

[lean crow]

AI would still explain this more in-depth

[white carbon]

it's a tool for expert users at best