Javascript 文档 : Returns null or type

Question

我有一个 js 类的函数，它可以返回一个字符串或 undefined .现在我想插入 return声明到函数的文档中。

    /**
     * Test documentation.
     * 
     * @param {(String|Number)} value - A String or a number containing a number.
     * 
     * @returns {(String|undefined)} - Returns a String or undefined.
     */
    nullOrString(value) {
        // ...
    }

但是当我调用该函数时， return 的文档语句只返回 String而不是 (String | undefined) .
我也试过 null而不是 undefined , 因为 undefined所有没有 return 的函数默认返回陈述。
那么如何在我的文档中添加 undefined或 null被退回？
编辑:
添加另一个测试功能。
请注意，这些示例是测试函数，不一定有意义。

     /**
     * Test documentation function.
     * 
     * @param {(String|Number)} input - Input String.
     * 
     * @returns {null|undefined} - Returns null when input is numeric, otherwise returns undefined.
     */
    undefinedOrNull(input) {
        if (!isNaN(parseFloat(input))) return null;
        return undefined;
    }

Visual Studio 代码返回:
undefinedOrNull(输入:字符串|数字):空
输入字符串。
测试文档功能。
@returns - - 当输入为数字时返回 null，否则返回 undefined。

Answer 1

你在那里的东西应该可以正常工作

/**
 * 
 * @param value
 * @returns {string|undefined}
 */
function nullOrString(value) {
  // ...
}

不需要括号，但这没关系，我认为你会想要一个小写字符串而不是字符串。