Improve <em></em> usage.

Author: costdev

src/Standards/Squiz/Docs/Commenting/BlockCommentStandard.xml

@@ -7,9 +7,9 @@
     <code_comparison>
         <code title="Valid: Uses a valid opener and closer.">
         <![CDATA[
-/*
+<em>/*</em>
     A block comment.
-*/
+<em>*/</em>
         ]]>
         </code>
         <code title="Invalid: Uses /** **/.">
@@ -23,10 +23,10 @@
     <code_comparison>
         <code title="Valid: Uses a valid opener and closer.">
         <![CDATA[
-/*
+<em>/*</em>
  * A block comment
  * with multiple lines.
-*/
+ <em>*/</em>
         ]]>
         </code>
         <code title="Invalid: Uses multiple // or #.">
@@ -47,9 +47,9 @@
     <code_comparison>
         <code title="Valid: Multi-line block comment.">
         <![CDATA[
-/*
+<em>/*
     A block comment.
-*/
+*/</em>
         ]]>
         </code>
         <code title="Invalid: Single line block comment.">
@@ -67,7 +67,7 @@
         <code title="Valid: A block comment with contents.">
         <![CDATA[
 /*
-    A block comment.
+<em>    A block comment.</em>
 */
         ]]>
         </code>
@@ -88,7 +88,7 @@
         <code title="Valid: Text starts on a new line.">
         <![CDATA[
 /*
-    A block comment.
+<em>    A block comment.</em>
 */
         ]]>
         </code>
@@ -108,9 +108,9 @@
         <code title="Valid: Indented by at least 4 spaces.">
         <![CDATA[
 /*
-    A block comment
-      with multiple lines.
-    And a second paragraph.
+<em>    </em>A block comment
+<em>      </em>with multiple lines.
+<em>    </em>And a second paragraph.
 */
         ]]>
         </code>
@@ -132,20 +132,20 @@
     <code_comparison>
         <code title="Valid: Asterisks are aligned.">
         <![CDATA[
-/*
- * A block comment
- * with
- * multiple lines.
- */
+/<em>*</em>
+ <em>*</em> A block comment
+ <em>*</em> with
+ <em>*</em> multiple lines.
+ <em>*</em>/
         ]]>
         </code>
         <code title="Invalid: Asterisks are not aligned.">
         <![CDATA[
 /*
  * A block comment
-  <em>* with</em>
+  <em>*</em> with
  * multiple lines.
-<em>*/</em>
+<em>*</em>/
         ]]>
         </code>
     </code_comparison>
@@ -158,7 +158,7 @@
         <code title="Valid: Starts with a capital letter.">
         <![CDATA[
 /*
-    A block comment.
+    <em>A</em> block comment.
 */
         ]]>
         </code>
@@ -180,13 +180,13 @@
         <![CDATA[
 /*
     A block comment.
-*/
+<em>*/</em>
         ]]>
         </code>
         <code title="Invalid: Closer is not on a new line.">
         <![CDATA[
 /*
-    <em>A block comment. */</em>
+    A block comment.<em> */</em>
         ]]>
         </code>
     </code_comparison>
@@ -196,32 +196,32 @@
     <code_comparison>
         <code title="Valid: The closer's asterisk is aligned with other asterisks.">
         <![CDATA[
-/*
- * A block comment
-<em> </em>*/
+/<em>*</em>
+ <em>*</em> A block comment
+ <em>*</em>/
         ]]>
         </code>
         <code title="Invalid: The closer's asterisk is not aligned with other asterisks.">
         <![CDATA[
 /*
  * A block comment.
-<em></em>*/
+<em>*</em>/
         ]]>
         </code>
     </code_comparison>
     <code_comparison>
         <code title="Valid: The closer's asterisk is aligned with the opener's slash.">
         <![CDATA[
-/*
+<em>/</em>*
     A block comment.
-<em></em>*/
+<em>*</em>/
         ]]>
         </code>
         <code title="Invalid: The closer's asterisk is not aligned with the opener's slash.">
         <![CDATA[
 /*
     A block comment.
-<em> </em>*/
+<em> *</em>/
         ]]>
         </code>
     </code_comparison>
@@ -236,7 +236,7 @@
 /*
     A block comment.
 */
-
+<em></em>
 echo 'Content';
         ]]>
         </code>
@@ -258,7 +258,7 @@ echo 'Content';
         <code title="Valid: No blank line after an open tag.">
         <![CDATA[
 <?php
-/*
+<em></em>/*
  * A block comment
  * with
  * multiple lines.