Merge pull request #175 from rodrigoprimo/php-syntax-documentation

Generic/PHP/Syntax: add XML documentation
PHPCSStandards · Jan 2, 2024 · fad8ffe · fad8ffe
2 parents d180eb0 + 2245a6b
commit fad8ffe
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/src/Standards/Generic/Docs/PHP/SyntaxStandard.xml b/src/Standards/Generic/Docs/PHP/SyntaxStandard.xml
@@ -0,0 +1,21 @@
+<documentation title="PHP Syntax">
+    <standard>
+    <![CDATA[
+    The code should use valid PHP syntax.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: No PHP syntax errors.">
+        <![CDATA[
+<em>echo "Hello!";</em>
+<em>$array = [1, 2, 3];</em>
+        ]]>
+        </code>
+        <code title="Invalid: Code contains PHP syntax errors.">
+        <![CDATA[
+echo "Hello!"<em></em> // Missing semicolon.
+$array = [1, 2, 3<em></em>; // Missing closing bracket.
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>