lua-users home
lua-l archive

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

I'd like to find a way to generate the ldoc function headers from the file automagically so I could fill in the details afterwards. 


Sent from my BlackBerry 10 smartphone on the Virgin Mobile network.
  Original Message  
From: steve donovan
Sent: Sunday, June 11, 2017 9:18 AM
To: Lua mailing list
Reply To: Lua mailing list
Subject: Re: Lua style guide ?

On Sun, Jun 11, 2017 at 1:36 PM, Martin <> wrote:
> May not, unless you are Steve Donovan.

Heh. Well to be honest, all the @ soup can be irritating. ldoc also
supports plain doc comments (that start with ---) without needing any
directives. (This is pretty much the style of the Lua standard library
as well) I think that some care in structured documentation is useful
for external APIs in dynamic languages, because there are no explicit
types. (In fact, I'm curious about any progress with TypedLua, since
dynamic languages with type annotations are fashionable at the