Javascript 文档：返回 null 或类型

Question

我有一个 js 类的函数，它可以返回 String 或undefined. 现在我想将该return语句插入到函数的文档中。

\n

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

\n

但是当我调用该函数时，该return语句的文档仅返回String而不返回(String | undefined)。\n我也尝试使用null而不是undefined，因为undefined默认情况下所有没有返回的函数都会返回return。

\n

那么如何将返回的undefinedor添加到我的文档中呢null？

\n

编辑： \n添加另一个测试函数。\n请注意，这些示例是测试函数，不一定有意义。

\n

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

\n

Visual Studio 代码返回：

\n

undefinedOrNull（输入：字符串|数字）：null

\n

输入字符串。

\n

测试文档功能。

\n

@returns \xe2\x80\x94 - 当输入为数字时返回 null，否则返回 undefined。

\n

Answer 1

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

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

不需要括号，但这不重要，我想你会想要一个小写字符串而不是字符串。