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

From Minetest Developer Wiki
Jump to navigation Jump to search
(Add more comments)
Line 5: Line 5:
 
:* Why are spaces around equals signs in short tables allowed to be omitted?  They help readability.
 
:* 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?
 
:* I think parenthesis almost always improve readability.  Why minimize the amount of them that you use?
:-- [[User:Sapier|Sapier]]
+
:* Definition of what makes a good comment needs to be more specific.
 
+
:* I think comparisons should always be to an explicit value.
 
 
Forgotten comments
 
:* Don't define unspecific must rules but declare them to be suggestions
 
:* Don't forbid perfectly fine coding style as comparing against nil
 
 
:-- [[User:Sapier|Sapier]]
 
:-- [[User:Sapier|Sapier]]

Revision as of 20:30, 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.
-- Sapier