Skip to content

Commit b6242a1

Browse files
committed
remove verbiage saying foreach @var usage is not covered by standard
1 parent 9c1cc86 commit b6242a1

File tree

1 file changed

+1
-12
lines changed

1 file changed

+1
-12
lines changed

proposed/phpdoc.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,7 @@ interpreted as described in [RFC 2119][RFC2119].
118118
}
119119
```
120120

121+
<<<<<<< HEAD
121122
It is NOT RECOMMENDED to use compound definitions for Constants or Properties, since the
122123
handling of DocBlocks in these situations can lead to unexpected results. If compound statement is
123124
used each element SHOULD have a preceding DocBlock.
@@ -143,18 +144,6 @@ interpreted as described in [RFC 2119][RFC2119].
143144
the variable in a foreach explicitly; several IDEs use this information to
144145
assist their auto-completion functionality.
145146

146-
This Standard does not cover this specific instance, as a `foreach` statement
147-
is considered to be a "Control Flow" statement rather than a "Structural Element".
148-
149-
```php
150-
/** @var \Sqlite3 $sqlite */
151-
foreach ($connections as $sqlite) {
152-
// there should be no docblock here
153-
$sqlite->open('/my/database/path');
154-
<...>
155-
}
156-
```
157-
158147
* "DocComment" is a special type of comment which MUST
159148

160149
- start with the character sequence `/**` followed by a whitespace character

0 commit comments

Comments
 (0)