diff --git a/phpBB/docs/coding-guidelines.html b/phpBB/docs/coding-guidelines.html index ded13d1c28..ceac388269 100644 --- a/phpBB/docs/coding-guidelines.html +++ b/phpBB/docs/coding-guidelines.html @@ -322,7 +322,7 @@ for ($i = 0; $i < $outer_size; $i++)
Functions should also be named descriptively. We're not programming in C here, we don't want to write functions called things like "stristr()". Again, all lower-case names with words separated by a single underscore character in PHP, and camel caps in JavaScript. Function names should preferably have a verb in them somewhere. Good function names are print_login_status()
, get_user_data()
, etc. Constructor functions in JavaScript should begin with a capital letter.
Functions should also be named descriptively. We're not programming in C here, we don't want to write functions called things like "stristr()". Again, all lower-case names with words separated by a single underscore character in PHP, and camel caps in JavaScript. Function names should be prefixed with "phpbb_" and preferably have a verb in them somewhere. Good function names are phpbb_print_login_status()
, phpbb_get_user_data()
, etc. Constructor functions in JavaScript should begin with a capital letter.
Arguments are subject to the same guidelines as variable names. We don't want a bunch of functions like: do_stuff($a, $b, $c)
. In most cases, we'd like to be able to tell how to use a function by just looking at its declaration.
The basic philosophy here is to not hurt code clarity for the sake of laziness. This has to be balanced by a little bit of common sense, though; print_login_status_for_a_given_user()
goes too far, for example -- that function would be better named print_user_login_status()
, or just print_login_status()
.
The basic philosophy here is to not hurt code clarity for the sake of laziness. This has to be balanced by a little bit of common sense, though; phpbb_print_login_status_for_a_given_user()
goes too far, for example -- that function would be better named phpbb_print_user_login_status()
, or just phpbb_print_login_status()
.
For all emoticons use the term smiley
in singular and smilies
in plural. For emails we use the term email
(without dash between “e” and “m”).