What's your In-Code Documentation Tool?

Showcase your libraries, tools and other projects that help your fellow love users.
Post Reply
CameronGoble
Prole
Posts: 3
Joined: Fri Sep 15, 2017 2:14 am

What's your In-Code Documentation Tool?

Post by CameronGoble » 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?

User avatar
Karai17
Party member
Posts: 879
Joined: Sun Sep 02, 2012 10:46 pm

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

Post by Karai17 » 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.
STI - An awesome Tiled library
LÖVE3D - A 3D library for LÖVE 0.10+

Dev Blog | GitHub | excessive ❤ moé

Post Reply

Who is online

Users browsing this forum: No registered users and 6 guests