Open main menu
Home
Random
Donate
Recent changes
Special pages
Community portal
Preferences
About Stockhub
Disclaimers
Search
User menu
Talk
Contributions
Create account
Log in
Editing
Module:Sandbox/Jeblad/LuaDoc/doc
(section)
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
===Additional comments=== There are available block comments in Lua, and they can also be used in code documented with LuaDoc. The commented blocks will be removed before further processing, making the resulting documentation stripped down to the bare running code. In Lua a block comment starts like <syntaxhighlight lang="lua" inline>--[[</syntaxhighlight> and run until the corresponding <syntaxhighlight lang="lua" inline>]]</syntaxhighlight>. Actually, if we add an additional leading hyphen then the comment will be turned into a single line comment. That leads to a situation whereby the following code can comment out a piece of code <syntaxhighlight lang="lua"> --[[ print(10) -- no action (comment) --]] </syntaxhighlight> Now, if we add a single hyphen to the first line, the code is in again: <syntaxhighlight lang="lua"> ---[[ print(10) --> 10 --]] </syntaxhighlight> To formalize this a little we will say that LuaDoc only act upon comments that are on a line by themselves. Other block comments are simply left as they are. Block comments can be specified a bit more, leading to nested comments. The regex we are using for block comments is like <code>\n%s*\-\-%b[](=*)&[].*\]\1\]</code>
Summary:
Please note that all contributions to Stockhub may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Stockhub:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)