JSDoc 中的文档约束

Document constraints in JSDoc

我有一个函数，它是一个 React 组件。它创建的元素具有 position:absolute; 为了使此 属性 以可预测的方式工作，父元素应使用 position: relatieve; 定位。我想让这个组件的未来用户知道这个约束。是否有用于此目的的 JSDoc 标签？你如何让这个组件的用户知道这个重要的约束？

您需要强调您的组件对特定外部状态具有 运行 时间依赖性。对此没有特定的 jsdoc 标记，您需要在说明中对其进行记录。

在 jsdoc2md 中，您可以声明任意标签，如果有帮助的话 - 您可以发明自己的标签来记录它。

自定义标记示例：

/**
 * This function has a wonderful custom tag
 * @createdIn Nigeria
 */
function customTaggedFunction () {}

产生这个输出：

customTaggedFunction()

这个函数有一个很棒的自定义标签

种类: 全局函数
创建：尼日利亚