When it comes to commenting code, you must find a balance between too much and too little. Comments are considered documentation that should be modified as a part of regular maintenance or development.
In general, its it is best to assume the reader understands the basics of Lua, so we recommend using comments in three two areas:
| Expand | |||||
|---|---|---|---|---|---|
| |||||
At the top of each module/function, you should provide a “header” comment block to document the history of the code:
|
...