Skip to content

Commit 756d822

Browse files
committed
Update inline-comments.md
According to the phpcs --standard=Joomla one should NOT have a single blank line before a comment or a block, if the comment is the first line of a code structure. (I.e, when the newline would appear after a '{' line, don't add it). Otherwise phpcs will complain with "Blank line found at start of control structure"
1 parent 956c04d commit 756d822

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

manual/en-US/coding-standards/chapters/inline-comments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Comments should precede the code they refer to. As a corollary, comments should
1616

1717
Don’t use a blank line between comments and the code they refer to (no space underneath a comment block).
1818

19-
Always have a single blank line before a comment or block of comments.
19+
Always have a single blank line before a comment or block of comments unless the comment (or block) is at the beginning of a code structure. ( You should not have a blank line after a '{' line )
2020

2121
Comments should align with the code they refer to, using the same indenting as the line that follows the comment.
2222

0 commit comments

Comments
 (0)