我有一个函数，它是一个 React 组件。它创建的元素具有position:absolute;为了使此属性以可预测的方式工作，父元素应使用position: relatieve;. 我想让这个组件的未来用户知道这个约束。是否有用于此目的的 JSDoc 标签？你如何让这个组件的用户知道这个重要的约束？
问问题
91 次
1 回答
1
您需要强调您的组件在运行时依赖于特定的外部状态。没有特定的 jsdoc 标签，您需要在描述中记录它。
在 jsdoc2md 中，您可以声明任意标签，如果有帮助 - 您可以发明自己的标签来记录它。
自定义标签示例：
/**
* This function has a wonderful custom tag
* @createdIn Nigeria
*/
function customTaggedFunction () {}
产生这个输出：
customTaggedFunction()
这个函数有一个很棒的自定义标签
种类：全球功能
创建地：尼日利亚
于 2020-01-09T11:16:02.723 回答