-
Notifications
You must be signed in to change notification settings - Fork 10
fix no multiline comments after declarations, fixes #96 #104
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report
@@ Coverage Diff @@
## master #104 +/- ##
==========================================
+ Coverage 98.47% 100% +1.52%
Complexity 124 124
==========================================
Files 6 6
Lines 523 520 -3
==========================================
+ Hits 515 520 +5
+ Misses 8 0 -8
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💯
@@ -42,6 +42,8 @@ class X | |||
/** @var int $bla */ | |||
$bla = 1; | |||
/** @var int $bla */ | |||
|
|||
return ($bla === $foo); /* yeah! */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why /* yeah! */? it reads awkward if in the same changeset with /* invalid doc block y is null by default */.
As the later suggests any comment after declarations/code is unwanted.
P.S.
I see, only after declarations. Maybe state this in the faulty comment above?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@calbrecht absolutely right. /* yeah! */
is misleading. I'll replace it with /* allowed single line comment */
. That should settle this.
Thank for this insightful comment 👍
multiline | ||
comment */ | ||
|
||
private $y = null; /** invalid doc block y is null by default */ | ||
private $q = null; /* invalid doc block y is null by default */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/* invalid doc block after declaration */ -- please :), same above
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct. This should be /* valid single line comment */
Initially discussed in #104 (review) we want to have comments that actually tell the developer *why* the comment itself is invalid or misplaced. /cc @calbrecht
Initially discussed in #104 (review) we want to have comments that actually tell the developer *why* the comment itself is invalid or misplaced. /cc @calbrecht
Initially discussed in mayflower#104 (review) we want to have comments that actually tell the developer *why* the comment itself is invalid or misplaced. /cc @calbrecht (cherry picked from commit 4806232)
Initially discussed in #104 (review) we want to have comments that actually tell the developer *why* the comment itself is invalid or misplaced. /cc @calbrecht (cherry picked from commit 4806232)
No description provided.