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

From Minetest Developer Wiki
Jump to navigation Jump to search
(Created page with "Noone will read this page so why even write something in here? ...")
 
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Noone will read this page so why even write something in here? ...
+
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. -- ''Agree'' [[User:Est31|Est31]] ([[User talk:Est31|talk]]) 01:00, 21 April 2015 (MSK)
 +
:* I think parenthesis almost always improve readability.  Why minimize the amount of them that you use? -- ''Agree'' [[User:Est31|Est31]] ([[User talk:Est31|talk]]) 01:00, 21 April 2015 (MSK)
 +
:* Definition of what makes a good comment needs to be more specific. -- ''Agree'' [[User:Est31|Est31]] ([[User talk:Est31|talk]]) 01:00, 21 April 2015 (MSK)
 +
:* I think comparisons should always be to an explicit value. -- ''I don't get what you want to accomplish with this one. With this, implementing simple things like a sorting algoritm would be very hard.'' [[User:Est31|Est31]] ([[User talk:Est31|talk]]) 01:00, 21 April 2015 (MSK)
 +
:Suggestions by [[User:Sapier|Sapier]].  Reworded by [[User:ShadowNinja|ShadowNinja]] to follow English grammar rules, interpretation may not be exactly correct.
 +
 
 +
Do we really need these excessive comment rules? I don't care whether they start with a capital letter, or there is a space after the "--". And that they should follow grammar is obvious. --[[User:Est31|Est31]] ([[User talk:Est31|talk]]) 01:00, 21 April 2015 (MSK)

Latest revision as of 22:00, 20 April 2015

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. -- Agree Est31 (talk) 01:00, 21 April 2015 (MSK)
  • I think parenthesis almost always improve readability. Why minimize the amount of them that you use? -- Agree Est31 (talk) 01:00, 21 April 2015 (MSK)
  • Definition of what makes a good comment needs to be more specific. -- Agree Est31 (talk) 01:00, 21 April 2015 (MSK)
  • I think comparisons should always be to an explicit value. -- I don't get what you want to accomplish with this one. With this, implementing simple things like a sorting algoritm would be very hard. Est31 (talk) 01:00, 21 April 2015 (MSK)
Suggestions by Sapier. Reworded by ShadowNinja to follow English grammar rules, interpretation may not be exactly correct.

Do we really need these excessive comment rules? I don't care whether they start with a capital letter, or there is a space after the "--". And that they should follow grammar is obvious. --Est31 (talk) 01:00, 21 April 2015 (MSK)