Support proposed `@global` phpdoc annotations (On function docblocks) · phan/phan#856

(0 留言) (0 反應) (0 負責人)PHP (5,455 star) (373 fork)batch import

enhancementhelp wanted

描述

I assume the syntax would be @global MyClass $someGlobalObject, similar to @var

This would help users who have issues such as https://github.com/etsy/phan/issues/834 (globals_type_map is another option, but mainly useful for things which have dozens or more uses and a unique name)

Suggested Implementation Details

Warn if the annotation exists, but global $x; doesn't occur within the scope of the function.
global T $x takes priority over var T $x
At the point where global $x is imported, assume it has type T1 if there is an phpdoc comment /** @global T1 $x description */ on the function
Deprecate @var $x on globals, by emitting a new issue type (that issue type can be turned off to suit project requirements)
Type should not leak out of the function, except through assignments to the global variable? Not sure.

技術棧: 無
領域: backend
議題類型: feature
難度: 4
預計時間: 3-5 days
活動狀態: stale
清晰度: mostly clear
前置要求: Knowledge of PHPDoc syntaxFamiliarity with Phan's internals
新手友善度: 15
研究方向: Investigate Phan's existing handling of @var and other docblock annotations in the codebase. Look at how global variable types are inferred. Design and implement parsing of @global annotation on function docblocks, ensuring it takes priority over @var. Also consider adding a warning if @global is present but no global statement exists. Finally, deprecate @var on globals with a new issue type. Relevant files may include the phpdoc parser and type inference modules.