Skip to content

Commit 5d1a3dc

Browse files
committed
Improve opener/closer descriptions and comparisons.
1 parent e122f81 commit 5d1a3dc

1 file changed

Lines changed: 8 additions & 57 deletions

File tree

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

Lines changed: 8 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,7 @@
55
]]>
66
</standard>
77
<code_comparison>
8-
<code title="Valid: Uses /* */.">
9-
<![CDATA[
10-
/*
11-
A block comment.
12-
*/
13-
]]>
14-
</code>
15-
<code title="Invalid: Uses /** */.">
16-
<![CDATA[
17-
<em>/**</em>
18-
A block comment.
19-
*/
20-
]]>
21-
</code>
22-
</code_comparison>
23-
<code_comparison>
24-
<code title="Valid: Uses /* */.">
25-
<![CDATA[
26-
/*
27-
A block comment.
28-
*/
29-
]]>
30-
</code>
31-
<code title="Invalid: Uses /* **/.">
32-
<![CDATA[
33-
/*
34-
A block comment.
35-
<em>**/</em>
36-
]]>
37-
</code>
38-
</code_comparison>
39-
<code_comparison>
40-
<code title="Valid: Uses /* */.">
8+
<code title="Valid: Uses a valid opener and closer.">
419
<![CDATA[
4210
/*
4311
A block comment.
@@ -53,38 +21,21 @@
5321
</code>
5422
</code_comparison>
5523
<code_comparison>
56-
<code title="Valid: Uses /* */.">
24+
<code title="Valid: Uses a valid opener and closer.">
5725
<![CDATA[
5826
/*
59-
A block comment
60-
with
61-
multiple lines.
27+
* A block comment
28+
* with multiple lines.
6229
*/
6330
]]>
6431
</code>
65-
<code title="Invalid: Uses multiple //.">
32+
<code title="Invalid: Uses multiple // or #.">
6633
<![CDATA[
6734
<em>//</em> A block comment
68-
<em>//</em> with
69-
<em>//</em> multiple lines.
70-
]]>
71-
</code>
72-
</code_comparison>
73-
<code_comparison>
74-
<code title="Valid: Uses /* */.">
75-
<![CDATA[
76-
/*
77-
A block comment
78-
with
79-
multiple lines.
80-
*/
81-
]]>
82-
</code>
83-
<code title="Invalid: Uses multiple #.">
84-
<![CDATA[
35+
<em>//</em> with multiple lines.
36+
8537
<em>#</em> A block comment
86-
<em>#</em> with
87-
<em>#</em> multiple lines.
38+
<em>#</em> with multiple lines.
8839
]]>
8940
</code>
9041
</code_comparison>

0 commit comments

Comments
 (0)