Differences

This shows you the differences between two versions of the page.

--- mantisbt:coding_guidelines [2014/02/13 21:57] – Note about CSS table-container. samwilson
+++ mantisbt:coding_guidelines [2025/01/11 10:16] (current) – [Coding Guidelines] fallback to PHP-FIG PER Coding Style dregad
@@ Line 8: / Line 8: @@
 The rest of this page describes in which ways we differ, as well as other Mantis-specific guidelines.
-Please discuss any omissions or disagreements on the [[http://mantisbt.org/mailinglists.php|Developers Mailing List]].
+If something is not defined in this document, then please apply the rules in PHP-FIG's [[https://www.php-fig.org/per/coding-style/|PER Coding Style]] as fallback.
+Please discuss any omissions or disagreements on our [[https://gitter.im/mantisbt/mantisbt|Gitter]] chat room, or in the [[http://mantisbt.org/forums|Forums]].
 ===== General Formatting =====
+  * Line length: should generally be kept below **80 chars**, although it is acceptable to have lines up to 120 chars when necessary.
   * Indentations: use TABS with a size of 4 (not spaces)
   * PHP tags: always use ''<?php'' and ''?>'', never ''<? ?>'' or ''<?= ?>''.
@@ Line 25: / Line 29: @@
 ===== Code Blocks =====
 ==== Braces and Parentheses ====
@@ Line 34: / Line 39: @@
     * No space before the opening parentheses ''('' in a condition, e.g. ''if( ...'' not ''if (''
     * One space after the opening ''('' and before the closing '')'' e.g. ''while( $i > 0 )'' not ''while($i > 0)''
+    * Arrays elements should be referenced without spaces, e.g. ''$arr['index']'' not ''$arr[ 'index' ]''
 Example:<code php>
@@ Line 84: / Line 90: @@
 ==== Switch statements ====
+Every case //must// have a ''break'' or another kind of exit statement, e.g. ''return'', ''die'', etc. If falling through to the following case is intended, it must be documented, unless the case does not contain any code. The ''break'' is not necessary for the final, default case.
 <code php>
@@ Line 92: / Line 100: @@
     case 2:
         blah;
-        # Fall through should be commented
+        # Fall through must be commented
-    case 3:
+    case 3:        # No need for a break here
     case 4:
         blah;
-        break;
+        return;    # No need for a break here
     default:
         blah;