lua-users home
lua-l archive

[Date Prev][Date Next][Thread Prev][Thread Next] [Date Index] [Thread Index]


On Tue, Mar 29, 2011 at 12:45 PM, Gaspard Bucher <gaspard@teti.ch> wrote:
> Naturaldocs lookd insteresting. Do you have an example of code and
> documentation ? From a wiki page [1], it seems that we need to add a lot of
> redundant stuff in the docs.

It is a bit more verbose, not too bad. Arguably, what matters is
readability, and personally I find '@param' to be not so easy on the
fingers anyway.

But it needs Perl, which is a heavy dependency for Windows people.

A next-generation Lua documentation tool could be taught to process
this 'natural' style of commenting.

steve d.