diff options
| author | James Atkinson <thefinn@users.sourceforge.net> | 2001-05-24 20:09:11 +0000 |
|---|---|---|
| committer | James Atkinson <thefinn@users.sourceforge.net> | 2001-05-24 20:09:11 +0000 |
| commit | d525c3bc51bb30f2e2ea07abc087ce8ab0f71613 (patch) | |
| tree | af6881b96814e7132504de0b697210964c889976 | |
| parent | c650e708c13204b9a38cbf4ae0eda1fd158c5dd3 (diff) | |
| download | forums-d525c3bc51bb30f2e2ea07abc087ce8ab0f71613.tar forums-d525c3bc51bb30f2e2ea07abc087ce8ab0f71613.tar.gz forums-d525c3bc51bb30f2e2ea07abc087ce8ab0f71613.tar.bz2 forums-d525c3bc51bb30f2e2ea07abc087ce8ab0f71613.tar.xz forums-d525c3bc51bb30f2e2ea07abc087ce8ab0f71613.zip | |
Added docs dir and some docs. Also working on Template 'how-to' doc, will be added later
git-svn-id: file:///svn/phpbb/trunk@320 89ea8834-ac86-4346-8a33-228a782c2dd0
| -rw-r--r-- | phpBB/docs/AUTHORS | 1 | ||||
| -rw-r--r-- | phpBB/docs/COPYING | 280 | ||||
| -rw-r--r-- | phpBB/docs/codingstandards.htm | 310 |
3 files changed, 591 insertions, 0 deletions
diff --git a/phpBB/docs/AUTHORS b/phpBB/docs/AUTHORS new file mode 100644 index 0000000000..051f10a415 --- /dev/null +++ b/phpBB/docs/AUTHORS @@ -0,0 +1 @@ +Please see: http://www.phpbb.com/credits.php for a list of all the people involved in phpBB. diff --git a/phpBB/docs/COPYING b/phpBB/docs/COPYING new file mode 100644 index 0000000000..c7aea1896f --- /dev/null +++ b/phpBB/docs/COPYING @@ -0,0 +1,280 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 675 Mass Ave, Cambridge, MA 02139, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS diff --git a/phpBB/docs/codingstandards.htm b/phpBB/docs/codingstandards.htm new file mode 100644 index 0000000000..1810af5589 --- /dev/null +++ b/phpBB/docs/codingstandards.htm @@ -0,0 +1,310 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!-- saved from url=(0044)http://area51.phpbb.com/codingstandards.html --> +<!-- saved from url=(0044)http://gti.2y.net/~nate/codingstandards.html --><HTML><HEAD><TITLE>phpBB Coding Standard Guidelines</TITLE> +<META http-equiv=Content-Type content="text/html; charset=windows-1252"> +<META content="MSHTML 5.50.4134.600" name=GENERATOR></HEAD> +<BODY text=#000000 vLink=#0000ff aLink=#cccccc link=#0000ff +bgColor=#ffffff><FONT face=verdana,arial,tahoma size=-1><A name=top></A> +<H2>phpBB Coding Standard Guidelines</H2>Comments or suggestions? email <A +href="mailto:nate@phpbb.com">nate@phpbb.com</A><BR><BR><A +href="http://gti.2y.net/~nate/codingstandards.html#editor">Editor +Settings</A><BR><A +href="http://gti.2y.net/~nate/codingstandards.html#naming">Naming +Conventions</A><BR><A +href="http://gti.2y.net/~nate/codingstandards.html#layout">Code Layout</A><BR><A +href="http://gti.2y.net/~nate/codingstandards.html#general">General +Guidelines</A><BR><BR><BR><A name=editor></A><A +href="http://gti.2y.net/~nate/codingstandards.html#top">top</A> +<H3>Editor Settings</H3> +<P><B>Tabs vs Spaces:</B> In order to make this as simple as possible, we will +be using tabs, not spaces. Feel free to set how many spaces your editor uses +when it <B>displays</B> tabs, but make sure that when you <B>save</B> the file, +it's saving tabs and not spaces. This way, we can each have the code be +displayed the way we like it, without breaking the layout of the actual files. +</P> +<P><B>Linefeeds:</B> Ensure that your editor is saving files in the UNIX format. +This means lines are terminated with a newline, not with a CR/LF combo as they +are on Win32, or whatever the Mac uses. Any decent Win32 editor should be able +to do this, but it might not always be the default. Know your editor. If you +want advice on Windows text editors, just ask one of the developers. Some of +them do their editing on Win32. </P><BR><BR><A name=naming></A><A +href="http://gti.2y.net/~nate/codingstandards.html#top">top</A> +<H3>Naming Conventions</H3> +<P>We will not be using any form of hungarian notation in our naming +conventions. Many of us believe that hungarian naming is one of the primary code +obfuscation techniques currently in use. </P> +<P><B>Variable Names:</B> Variable names should be in all lowercase, with words +separated by an underscore. <BR><BR> Example: <CODE><FONT +size=+1>$current_user</FONT></CODE> is right, but <CODE><FONT +size=+1>$currentuser</FONT></CODE> and <CODE><FONT +size=+1>$currentUser</FONT></CODE> are not. <BR><BR>Names should be descriptive, +but concise. We don't want huge sentences as our variable names, but typing an +extra couple of characters is always better than wondering what exactly a +certain variable is for. </P> +<P><B>Loop Indices:</B> The <I>only</I> situation where a one-character variable +name is allowed is when it's the index for some looping construct. In this case, +the index of the outer loop should always be $i. If there's a loop inside that +loop, its index should be $j, followed by $k, and so on. If the loop is being +indexed by some already-existing variable with a meaningful name, this guideline +does not apply. <BR><BR> Example: <PRE><FONT size=+1> + for ($i = 0; $i < $outer_size; $i++) + { + for ($j = 0; $j < $inner_size; $j++) + { + foo($i, $j); + } + } </FONT></PRE> +<P></P> +<P><B>Function Names:</B> 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. Function names should preferably have a verb in them +somewhere. Good function names are <CODE><FONT +size=+1>print_login_status()</FONT></CODE>, <CODE><FONT +size=+1>get_user_data()</FONT></CODE>, etc.. </P> +<P><B>Function Arguments:</B> Arguments are subject to the same guidelines as +variable names. We don't want a bunch of functions like: <CODE><FONT +size=+1>do_stuff($a, $b, $c)</FONT></CODE>. In most cases, we'd like to be able +to tell how to use a function by just looking at its declaration. </P> +<P><B>Summary:</B> 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; <CODE><FONT size=+1>print_login_status_for_a_given_user()</FONT></CODE> +goes too far, for example -- that function would be better named <CODE><FONT +size=+1>print_user_login_status()</FONT></CODE> , or just <CODE><FONT +size=+1>print_login_status()</FONT></CODE>. </P><BR><BR><A name=layout></A><A +href="http://gti.2y.net/~nate/codingstandards.html#top">top</A> +<H3>Code Layout</H3> +<P><B>Standard header for new files:</B> Here a template of the header that must +be included at the start of all phpBB files: <PRE><FONT size=+1> + /*************************************************************************** + filename.php + ------------------- + begin : Sat June 17 2000 + copyright : (C) 2000 The phpBB Group + email : support@phpBB.com + + $Id$ + + ***************************************************************************/ + + /*************************************************************************** + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + ***************************************************************************/ + </FONT></PRE> +<P></P> +<P><B>Always include the braces:</B> This is another case of being too lazy to +type 2 extra characters causing problems with code clarity. Even if the body of +some construct is only one line long, do <I>not</I> drop the braces. Just don't. +<BR><BR> Examples:<PRE><FONT size=+1> + /* These are all wrong. */ + if (condition) do_stuff(); + if (condition) + do_stuff(); + while (condition) + do_stuff(); + for ($i = 0; $i < size; $i++) + do_stuff($i); + + /* These are right. */ + if (condition) + { + do_stuff(); + } + while (condition) + { + do_stuff(); + } + for ($i = 0; $i < size; $i++) + { + do_stuff(); + } + </FONT></PRE> +<P></P> +<P><B>Where to put the braces:</B> This one is a bit of a holy war, but we're +going to use a style that can be summed up in one sentence: Braces always go on +their own line. The closing brace should also always be at the same column as +the corresponding opening brace. <BR><BR> Examples:<PRE><FONT size=+1> + if (condition) + { + while (condition2) + { + ... + } + } + else + { + ... + } + + for ($i = 0; $i < $size; $i++) + { + ... + } + + while (condition) + { + ... + } + + function do_stuff() + { + ... + } + </FONT></PRE> +<P></P> +<P><B>Use spaces between tokens:</B> This is another simple, easy step that +helps keep code readable without much effort. Whenever you write an assignment, +expression, etc.. Always leave <I>one</I> space between the tokens. Basically, +write code as if it was English. Put spaces between variable names and +operators. Don't put spaces just after an opening bracket or before a closing +bracket. Don't put spaces just before a comma or a semicolon. This is best shown +with a few examples. <BR><BR> Examples:<PRE><FONT size=+1> + /* Each pair shows the wrong way followed by the right way. */ + + $i=0; + $i = 0; + + if($i<7) ... + if ($i < 7) ... + + if ( ($i < 7)&&($j > 8) ) ... + if (($i < 7) && ($j > 8)) ... + + do_stuff( $i, "foo", $b ); + do_stuff($i, "foo", $b); + + for($i=0; $i<$size; $i++) ... + for($i = 0; $i < $size; $i++) ... + + $i=($j < $size)?0:1; + $i = ($j < $size) ? 0 : 1; + </FONT></PRE> +<P></P> +<P><B>Operator precedence:</B> Do you know the exact precedence of all the +operators in PHP? Neither do I. Don't guess. Always make it obvious by using +brackets to force the precedence of an equation so you know what it does. +<BR><BR> Examples:<PRE><FONT size=+1> + /* what's the result? who knows. */ + $bool = ($i < 7 && $j > 8 || $k == 4); + + /* now you can be certain what I'm doing here. */ + $bool = (($i < 7) && (($j < 8) || ($k == 4))) + </FONT></PRE> +<P></P> +<P><B>SQL code layout:</B> Since we'll all be using different editor settings, +don't try to do anything complex like aligning columns in SQL code. Do, however, +break statements onto their own lines. Here's a sample of how SQL code should +look. Note where the lines break, the capitalization, and the use of brackets. +<BR><BR> Examples:<PRE><FONT size=+1> + SELECT field1 AS something, field2, field3 + FROM table a, table b + WHERE (this = that) AND (this2 = that2) + </FONT></PRE> +<P></P><BR><BR><A name=general></A><A +href="http://gti.2y.net/~nate/codingstandards.html#top">top</A> +<H3>General Guidelines</H3> +<P><B>Quoting strings:</B> There are two different ways to quote strings in PHP +- either with single quotes or with double quotes. The main difference is that +the parser does variable interpolation in double-quoted strings, but not in +single quoted strings. Because of this, you should <I>always</I> use single +quotes <I>unless</I> you specifically need variable interpolation to be done on +that string. This way, we can save the parser the trouble of parsing a bunch of +strings where no interpolation needs to be done. Also, if you are using a string +variable as part of a function call, you do not need to enclose that variable in +quotes. Again, this will just make unnecessary work for the parser. Note, +however, that nearly all of the escape sequences that exist for double-quoted +strings will not work with single-quoted strings. Be careful, and feel free to +break this guideline if it's making your code harder to read. +<BR><BR> Examples:<PRE><FONT size=+1> + /* wrong */ + $str = "This is a really long string with no variables for the parser to find."; + do_stuff("$str"); + + /* right */ + $str = 'This is a really long string with no variables for the parser to find.'; + do_stuff($str); + </FONT></PRE> +<P></P> +<P><B>Associative array keys:</B> In PHP, it's legal to use a literal string as +a key to an associative array without quoting that string. We don't want to do +this -- the string should always be quoted to avoid confusion. Note that this is +only when we're using a literal, not when we're using a variable. +<BR><BR> Examples:<PRE><FONT size=+1> + /* wrong */ + $foo = $assoc_array[blah]; + + /* right */ + $foo = $assoc_array['blah']; + </FONT></PRE> +<P></P> +<P><B>Comments:</B> Each function should be preceded by a comment that tells a +programmer everything they need to know to use that function. The meaning of +every parameter, the expected input, and the output are required as a minimal +comment. The function's behaviour in error conditions (and what those error +conditions are) should also be present. Nobody should have to look at the actual +source of a function in order to be able to call it with confidence in their own +code. <BR><BR>In addition, commenting any tricky, obscure, or otherwise +not-immediately-obvious code is clearly something we should be doing. Especially +important to document are any assumptions your code makes, or preconditions for +its proper operation. Any one of the developers should be able to look at any +part of the application and figure out what's going on in a reasonable amount of +time. </P> +<P><B>Magic numbers:</B> Don't use them. Use named constants for any literal +value other than obvious special cases. Basically, it's OK to check if an array +has 0 elements by using the literal 0. It's not OK to assign some special +meaning to a number and then use it everywhere as a literal. This hurts +readability AND maintainability. Included in this guideline is that we should be +using the constants TRUE and FALSE in place of the literals 1 and 0 -- even +though they have the same values, it's more obvious what the actual logic is +when you use the named constants. </P> +<P><B>Shortcut operators:</B> The only shortcut operators that cause readability +problems are the shortcut increment ($i++) and decrement ($j--) operators. These +operators should not be used as part of an expression. They can, however, be +used on their own line. Using them in expressions is just not worth the +headaches when debugging. <BR><BR> Examples:<PRE><FONT size=+1> + /* wrong */ + $array[++$i] = $j; + $array[$i++] = $k; + + + /* right */ + $i++; + $array[$i] = $j; + + $array[$i] = $k; + $i++; + </FONT></PRE> +<P></P> +<P><B>Inline conditionals:</B> Inline conditionals should only be used to do +very simple things. Preferably, they will only be used to do assignments, and +not for function calls or anything complex at all. They can be harmful to +readability if used incorrectly, so don't fall in love with saving typing by +using them. <BR><BR> Examples:<PRE><FONT size=+1> + /* Bad place to use them */ + (($i < $size) && ($j > $size)) ? do_stuff($foo) : do_stuff($bar); + + + /* OK place to use them */ + $min = ($i < $j) ? $i : $j; + </FONT></PRE> +<P></P> +<P><B>Don't use uninitialized variables.</B> for phpBB 2, we intend to use a +higher level of run-time error reporting. This will mean that the use of an +uninitialized variable will be reported as an error. This will come up most +often when checking which HTML form variables were passed. These errors can be +avoided by using the built-in isset() function to check whether a variable has +been set. <BR><BR> Examples:<PRE><FONT size=+1> + /* Old way */ + if ($forum) ... + + + /* New way */ + if (isset($forum)) ... + </FONT></PRE> +<P></P><BR><BR><A href="http://gti.2y.net/~nate/codingstandards.html#top">Return +to top</A> </FONT></BODY></HTML> |