File tree Expand file tree Collapse file tree 1 file changed +16
-16
lines changed
src/Standards/Squiz/Docs/Commenting Expand file tree Collapse file tree 1 file changed +16
-16
lines changed Original file line number Diff line number Diff line change 151151 </code_comparison >
152152 <standard >
153153 <![CDATA[
154- The block comment closer should be on a new line .
154+ A block comment should start with a capital letter .
155155 ]]>
156156 </standard >
157157 <code_comparison >
158- <code title =" Valid: Closer is on a new line ." >
158+ <code title =" Valid: Starts with a capital letter ." >
159159 <![CDATA[
160160/*
161161 A block comment.
162162*/
163163 ]]>
164164 </code >
165- <code title =" Invalid: Closer is not on a new line ." >
165+ <code title =" Invalid: Does not start with a capital letter ." >
166166 <![CDATA[
167167/*
168- <em>A block comment. */</em>
168+ <em>a</em> block comment.
169+ */
169170 ]]>
170171 </code >
171172 </code_comparison >
172173 <standard >
173174 <![CDATA[
174- There should be an empty line after the block comment .
175+ The block comment closer should be on a new line .
175176 ]]>
176177 </standard >
177178 <code_comparison >
178- <code title =" Valid: An empty line after the comment ." >
179+ <code title =" Valid: Closer is on a new line ." >
179180 <![CDATA[
180181/*
181182 A block comment.
182183*/
183-
184- echo 'Content';
185184 ]]>
186185 </code >
187- <code title =" Invalid: No empty line after the comment ." >
186+ <code title =" Invalid: Closer is not on a new line ." >
188187 <![CDATA[
189188/*
190- A block comment.
191- */
192- <em>echo 'Content';</em>
189+ <em>A block comment. */</em>
193190 ]]>
194191 </code >
195192 </code_comparison >
196193 <standard >
197194 <![CDATA[
198- A block comment should start with a capital letter .
195+ There should be an empty line after the block comment .
199196 ]]>
200197 </standard >
201198 <code_comparison >
202- <code title =" Valid: Starts with a capital letter ." >
199+ <code title =" Valid: An empty line after the comment ." >
203200 <![CDATA[
204201/*
205202 A block comment.
206203*/
204+
205+ echo 'Content';
207206 ]]>
208207 </code >
209- <code title =" Invalid: Does not start with a capital letter ." >
208+ <code title =" Invalid: No empty line after the comment ." >
210209 <![CDATA[
211210/*
212- <em>a</em> block comment.
211+ A block comment.
213212*/
213+ <em>echo 'Content';</em>
214214 ]]>
215215 </code >
216216 </code_comparison >
You can’t perform that action at this time.
0 commit comments