Difference between revisions of "Talk:Lua code style guidelines"

From Minetest Developer Wiki
Jump to navigation Jump to search
(Add more comments)
Line 7: Line 7:
 
:* Definition of what makes a good comment needs to be more specific.
 
:* Definition of what makes a good comment needs to be more specific.
 
:* I think comparisons should always be to an explicit value.
 
:* I think comparisons should always be to an explicit value.
:-- [[User:Sapier|Sapier]]
+
:-- ShadowNinja interpretation of comments written by Sapier

Revision as of 21:51, 18 August 2014

Suggestions for this page:

  • Multi-line comment style should be specified.
  • Why shouldn't DoxyGen be used?
  • I like to use something more visual like a line of dashes to separate top-level functions.
  • Why are spaces around equals signs in short tables allowed to be omitted? They help readability.
  • I think parenthesis almost always improve readability. Why minimize the amount of them that you use?
  • Definition of what makes a good comment needs to be more specific.
  • I think comparisons should always be to an explicit value.
-- ShadowNinja interpretation of comments written by Sapier