Difference between revisions of "Talk:Developer Area/Coding guidelines"

From Mahara Wiki
Jump to navigation Jump to search
Line 2: Line 2:
  
 
'''Functions, Classes'''
 
'''Functions, Classes'''
* Make sure function name starts from letter (no _ before function names).
+
* Make sure function name starts from letter (no _ before function names, private should be declared as private, php4 time is gone :).
* Single whitespace between functions and between function and code
+
* Single empty line between functions and between function and code
* Double whitespace between classes
+
* Double empty line between classes
  
 
'''Variables'''
 
'''Variables'''

Revision as of 20:26, 5 September 2013

What needs to be added

Functions, Classes

  • Make sure function name starts from letter (no _ before function names, private should be declared as private, php4 time is gone :).
  • Single empty line between functions and between function and code
  • Double empty line between classes

Variables

  • No hardcoded binary (security reasons)
  • No hardcoded serialised data (security reasons)

general

  • No closing php tag
  • No whitespaces at the end is required (currently it is just recommend)

Control statements

  • "case" multiline syntax:
case:
   a = 25;
   b = 100;
   break;

not

case: a = 25; b = 100; break;