@returns
The @returns
tag can be used to document the return value of a function. At most one @returns
tag should be present in a comment.
Example
/**
* @param a - the first number
* @param b - the second number
* @returns The sum of `a` and `b`
*/
export function sum(a: number, b: number): number;
See Also
- The
@param
tag