如何使用JSDoc标注函数参数为任意HTMLElement类型?
如何在JSDoc中标注任意HTMLElement作为函数参数
嘿,其实你当前的写法就已经完全正确啦!
在JSDoc里,HTMLElement是所有HTML元素的基类——不管是<div>、<p>、<button>还是其他任何HTML标签对应的DOM对象,都继承自这个类。所以你用@param {HTMLElement} node - 要移除子元素的HTML元素这个标注,已经准确表达了node可以是任意HTML元素的意思。
如果你的函数需要明确允许null或undefined(就像你代码里处理的那样),还可以把类型标注扩展成:
/** * 传入一个包含子元素的元素以移除其所有子元素 * * @param {HTMLElement|null|undefined} node - 要移除子元素的HTML元素(可传入null或undefined) */
另外,如果你用的是支持JSDoc的编辑器(比如VS Code),这样的标注还能提供正确的代码提示——当你传入任何HTML元素时,编辑器都会识别它的类型并给出对应的属性/方法提示,完全符合你的需求。
内容的提问来源于stack exchange,提问作者virtualLast
相关产品推荐
相关产品推荐

