Rush StackShopBlogEvents
Skip to main content

@param

Standardization:Core
Syntax kind:Block tag

Usage

Used to document a function parameter. The @param tag is followed by a parameter name, followed by a hyphen, followed by a description.

Example

/**
* Returns the average of two numbers.
*
* @remarks
* This method is part of the {@link core-library#Statistics | Statistics subsystem}.
*
* @param x - The first input number
* @param y - The second input number
* @returns The arithmetic mean of `x` and `y`
*
* @beta
*/
function getAverage(x: number, y: number): number {
return (x + y) / 2.0;
}

See also