Skip to content

Commit 6050c60

Browse files
committed
Fixed headlines in Readme
1 parent 5935cf4 commit 6050c60

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

+35
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ For loops that have only a second expression (the condition) should be converted
2323
</td>
2424
</tr>
2525
</table>
26+
2627
## Jumbled Incrementers
2728
Incrementers in nested loops should use different variable names.
2829
<table>
@@ -49,6 +50,7 @@ Incrementers in nested loops should use different variable names.
4950
</td>
5051
</tr>
5152
</table>
53+
5254
## Unnecessary Final Modifiers
5355
Methods should not be declared final inside of classes that are declared final.
5456
<table>
@@ -79,6 +81,7 @@ Methods should not be declared final inside of classes that are declared final.
7981
</td>
8082
</tr>
8183
</table>
84+
8285
## Useless Overriding Methods
8386
Methods should not be defined that only call the parent method.
8487
<table>
@@ -112,6 +115,7 @@ Methods should not be defined that only call the parent method.
112115
</td>
113116
</tr>
114117
</table>
118+
115119
## Todo Comments
116120
FIXME Statements should be taken care of.
117121
<table>
@@ -138,6 +142,7 @@ FIXME Statements should be taken care of.
138142
</td>
139143
</tr>
140144
</table>
145+
141146
## Todo Comments
142147
TODO Statements should be taken care of.
143148
<table>
@@ -164,6 +169,7 @@ TODO Statements should be taken care of.
164169
</td>
165170
</tr>
166171
</table>
172+
167173
## Inline Control Structures
168174
Control Structures should use braces.
169175
<table>
@@ -187,6 +193,7 @@ Control Structures should use braces.
187193
</td>
188194
</tr>
189195
</table>
196+
190197
## Byte Order Marks
191198
Byte Order Marks that may corrupt your application should not be used. These include 0xefbbbf (UTF-8), 0xfeff (UTF-16 BE) and 0xfffe (UTF-16 LE).
192199
## Inline HTML
@@ -214,6 +221,7 @@ Files that contain php code should only have php code and should not have any &q
214221
</td>
215222
</tr>
216223
</table>
224+
217225
## Line Endings
218226
Unix-style line endings are preferred (&quot;\n&quot; instead of &quot;\r\n&quot;).
219227
## One Class Per File
@@ -246,6 +254,7 @@ There should only be one class defined in a file.
246254
</td>
247255
</tr>
248256
</table>
257+
249258
## One Interface Per File
250259
There should only be one interface defined in a file.
251260
<table>
@@ -276,6 +285,7 @@ There should only be one interface defined in a file.
276285
</td>
277286
</tr>
278287
</table>
288+
279289
## Multiple Statements On a Single Line
280290
Multiple statements are not allowed on a single line.
281291
<table>
@@ -297,6 +307,7 @@ Multiple statements are not allowed on a single line.
297307
</td>
298308
</tr>
299309
</table>
310+
300311
## Space After Casts
301312
Spaces are not allowed after casting operators.
302313
<table>
@@ -317,6 +328,7 @@ Spaces are not allowed after casting operators.
317328
</td>
318329
</tr>
319330
</table>
331+
320332
## Call-Time Pass-By-Reference
321333
Call-time pass-by-reference is not allowed. It should be declared in the function definition.
322334
<table>
@@ -349,6 +361,7 @@ Call-time pass-by-reference is not allowed. It should be declared in the functio
349361
</td>
350362
</tr>
351363
</table>
364+
352365
## Function Argument Spacing
353366
Function arguments should have one space after a comma, and single spaces surrounding the equals sign for default values.
354367
<table>
@@ -395,6 +408,7 @@ Function arguments should have one space after a comma, and single spaces surrou
395408
</td>
396409
</tr>
397410
</table>
411+
398412
## Opening Brace in Function Declarations
399413
Function declarations follow the &quot;Kernighan/Ritchie style&quot;. The function brace is on the same line as the function declaration. One space is required between the closing parenthesis and the brace.
400414
<table>
@@ -420,6 +434,7 @@ Function declarations follow the &quot;Kernighan/Ritchie style&quot;. The functi
420434
</td>
421435
</tr>
422436
</table>
437+
423438
## Constructor name
424439
Constructors should be named __construct, not after the class.
425440
<table>
@@ -450,6 +465,7 @@ Constructors should be named __construct, not after the class.
450465
</td>
451466
</tr>
452467
</table>
468+
453469
## Constant Names
454470
Constants should always be all-uppercase, with underscores to separate words.
455471
<table>
@@ -480,6 +496,7 @@ Constants should always be all-uppercase, with underscores to separate words.
480496
</td>
481497
</tr>
482498
</table>
499+
483500
## Opening Tag at Start of File
484501
The opening php tag should be the first item in the file.
485502
<table>
@@ -503,6 +520,7 @@ The opening php tag should be the first item in the file.
503520
</td>
504521
</tr>
505522
</table>
523+
506524
## Deprecated Functions
507525
Deprecated functions should not be used.
508526
<table>
@@ -523,6 +541,7 @@ Deprecated functions should not be used.
523541
</td>
524542
</tr>
525543
</table>
544+
526545
## PHP Code Tags
527546
Always use &lt;?php ?&gt; to delimit PHP code, not the &lt;? ?&gt; shorthand. This is the most portable way to include PHP code on differing operating systems and setups.
528547
## Forbidden Functions
@@ -545,6 +564,7 @@ The forbidden functions sizeof() and delete() should not be used.
545564
</td>
546565
</tr>
547566
</table>
567+
548568
## Lowercase Keywords
549569
All PHP keywords should be lowercase.
550570
<table>
@@ -565,6 +585,7 @@ All PHP keywords should be lowercase.
565585
</td>
566586
</tr>
567587
</table>
588+
568589
## No Space Indentation
569590
Tabs should be used for indentation instead of spaces.
570591
## Control Structure Signatures
@@ -610,6 +631,7 @@ Control structures should use one space around the parentheses in conditions. T
610631
</td>
611632
</tr>
612633
</table>
634+
613635
## Default Values in Function Declarations
614636
Arguments with default values go at the end of the argument list.
615637
<table>
@@ -636,6 +658,7 @@ Arguments with default values go at the end of the argument list.
636658
</td>
637659
</tr>
638660
</table>
661+
639662
## Class Declaration
640663
Each class must be in a file by itself and must be under a namespace (a top-level vendor name).
641664
<table>
@@ -691,6 +714,7 @@ Each class must be in a file by itself and must be under a namespace (a top-leve
691714
</td>
692715
</tr>
693716
</table>
717+
694718
## Namespace Declarations
695719
There must be one blank line after the namespace declaration.
696720
<table>
@@ -714,6 +738,7 @@ There must be one blank line after the namespace declaration.
714738
</td>
715739
</tr>
716740
</table>
741+
717742
## Namespace Declarations
718743
Each use declaration must contain only one namespace and must come after the first namespace declaration. There should be one blank line after the final use statement.
719744
<table>
@@ -784,6 +809,7 @@ Each use declaration must contain only one namespace and must come after the fir
784809
</td>
785810
</tr>
786811
</table>
812+
787813
## Closing PHP Tags
788814
Files should not have closing php tags.
789815
<table>
@@ -807,6 +833,7 @@ Files should not have closing php tags.
807833
</td>
808834
</tr>
809835
</table>
836+
810837
## Array Bracket Spacing
811838
When referencing arrays you should not put whitespace around the opening bracket or before the closing bracket.
812839
<table>
@@ -827,6 +854,7 @@ When referencing arrays you should not put whitespace around the opening bracket
827854
</td>
828855
</tr>
829856
</table>
857+
830858
## Lowercase Class Keywords
831859
The php keywords class, interface, trait, extends, implements, abstract, final, var, and const should be lowercase.
832860
<table>
@@ -851,6 +879,7 @@ The php keywords class, interface, trait, extends, implements, abstract, final,
851879
</td>
852880
</tr>
853881
</table>
882+
854883
## Self Member Reference
855884
The self keyword should be used instead of the current class name, should be lowercase, and should not have spaces before or after it.
856885
<table>
@@ -927,6 +956,7 @@ The self keyword should be used instead of the current class name, should be low
927956
</td>
928957
</tr>
929958
</table>
959+
930960
## Doc Comment Alignment
931961
The asterisks in a doc comment should align, and there should be one space between the asterisk and tags.
932962
<table>
@@ -973,6 +1003,7 @@ The asterisks in a doc comment should align, and there should be one space betwe
9731003
</td>
9741004
</tr>
9751005
</table>
1006+
9761007
## Doc Comment Throws Tag
9771008
If a function throws any exceptions, they should be documented in a @throws tag.
9781009
<table>
@@ -1006,6 +1037,7 @@ If a function throws any exceptions, they should be documented in a @throws tag.
10061037
</td>
10071038
</tr>
10081039
</table>
1040+
10091041
## Static This Usage
10101042
Static methods should not use $this.
10111043
<table>
@@ -1038,6 +1070,7 @@ Static methods should not use $this.
10381070
</td>
10391071
</tr>
10401072
</table>
1073+
10411074
## Echoed Strings
10421075
Simple strings should not be enclosed in parentheses when being echoed.
10431076
<table>
@@ -1058,6 +1091,7 @@ Simple strings should not be enclosed in parentheses when being echoed.
10581091
</td>
10591092
</tr>
10601093
</table>
1094+
10611095
## Language Construct Whitespace
10621096
The php constructs echo, print, return, include, include_once, require, require_once, and new should have one space after them.
10631097
<table>
@@ -1078,6 +1112,7 @@ The php constructs echo, print, return, include, include_once, require, require_
10781112
</td>
10791113
</tr>
10801114
</table>
1115+
10811116
## Semicolon Spacing
10821117
Semicolons should not have spaces before them.
10831118
<table>

0 commit comments

Comments
 (0)