PHP Tools for Visual Studio - Documentation

Inlay Hints

Inlay Hints are additional intra-text-information appearing in code. They add contextual and type data, which makes the code easier to read and navigate.

inlay hints in PHP

Parameters Name

The parameter name is prepended to all function arguments. The syntax matches the PHP-named-parameters syntax.

inlay hints in PHP

Double-click on the inlay hint to insert the named parameter into the code.

inlay hints in PHP

Settings:

  • "php.inlayHints.parameters.enabled": true: enable or disable the inlay hint for parameter names.
  • "php.inlayHints.parameters.suppressNameMatchingValue": false: hide parameter name if it is the same as the value.

Parameters By-Ref

Arguments passed by reference are annotated with & sign.

inlay hints in PHP

Setting: "php.inlayHints.parameters.byReference": true

Return Type

Return types are annotated in case they are not specified. The type is inferred from the code type analysis; and shortened using the current namespace context.

Double-click on the inlay hint to insert the return type into the code.

inlay hints in PHP

Setting: "php.inlayHints.types.return": true

Variable Assignment Type

Variable assignments are annotated with the resulting type.

Setting: "php.inlayHints.types.variable": true

@psalm-trace Type

(Available since 1.44) For "debugging" the editor's type inferrence, take advantage of @trace or @psalm-trace documentary comments tags. Inlay hint with the inferred type will be added to the expression.

inlay hints in PHP

Customization

In addition to the settings above, there are global settings:

  • "editor.inlayHints.enabled"
  • "editor.inlayHints.padding"
  • "editor.inlayHints.fontFamily"
  • "editor.inlayHints.fontSize"

To customize the inlay hints colors, alter the theme colors using "workbench.colorCustomizations": {} setting.

Example:

"workbench.colorCustomizations": {
    "editorInlayHint.background": "#f00",
    "editorInlayHint.foreground": "#fff"
},

All inlay colors:

  • editorInlayHint.background: Background color of inline hints.
  • editorInlayHint.foreground: Foreground color of inline hints.
  • editorInlayHint.typeForeground: Foreground color of inline hints for types
  • editorInlayHint.typeBackground: Background color of inline hints for types
  • editorInlayHint.parameterForeground: Foreground color of inline hints for parameters
  • editorInlayHint.parameterBackground: Background color of inline hints for parameters

See also