LÖVE

Posted: **Mon Jun 10, 2019 8:39 pm**

So I'm trying to be more diligent with my commenting and documentation upkeep, as I hope to release my first library into the wild soon. I see a lot of code that has this sort of commenting in it:

Code: Select all

------------------------------------
--- This is my module.
-- @param This does one thing
-- @return And it returns this back
--------------------------------------------

...which I really like a lot. Especially since it can auto-generate documentation! And there seem to be a lot of tools out there with pros and cons.

So: What are your favorite tools for commenting and generating documents for your LÖVE code?

Posted: **Tue Jun 11, 2019 4:50 am**

I think in general for Lua the usual choice is LDoc, which is the Lua documentation generator that uses the syntax denoted above. I use it for my libs.

LÖVE

What's your In-Code Documentation Tool?

What's your In-Code Documentation Tool?

Re: What's your In-Code Documentation Tool?