Hover & Signature Help

The language server surfaces the SFCC API's documentation right where you are typing - no switching to the docs site to remember a method signature or what an argument expects.

Hover

Hover over a symbol to see a formatted card with its kind, type signature, and documentation.

var OrderMgr = require('dw/order/OrderMgr');
OrderMgr.getOrder('00001');
//       ^ hover shows the signature and JSDoc for getOrder()

A hover card includes:

• Kind & signature - e.g. (method) OrderMgr.getOrder(orderNo: string): Order.
• Documentation - the official JSDoc description, rendered as Markdown, with @param, @returns, @example, and @deprecated tags.
• Resolved links - {@link …} references in the docs become clickable.

Hover works on the whole dw.* API, on your own functions and variables (showing their inferred types and any JSDoc you wrote), and on symbols brought in via require() or importScript.

Signature Help

As you fill in a function call, signature help pops up to show the parameter list and highlights the argument you are currently typing.

var URLUtils = require('dw/web/URLUtils');
URLUtils.url('Product-Show', 'pid', product.ID);
//           └─ signature help shows each parameter and bolds the active one

Signature help:

• Triggers automatically on ( and ,, and can be re-invoked with Cmd/Ctrl+Shift+Space.
• Shows per-parameter documentation pulled from @param tags.
• Steps through overloads when an API method has more than one signature.
• Works for the dw.* API and for your own JSDoc-documented functions.

Inlay Hints

Where it helps readability, the server can render inlay hints inline in the editor - for example, parameter-name hints at call sites and inferred type hints. These are non-editable annotations drawn between tokens, controlled by VS Code's standard editor.inlayHints settings.

createGiftCertificate(/* amount: */ 50, /* currency: */ 'USD');
//                       ^ inlay hints show the parameter names

Related Pages