我有一个功能,它是一个React组件。它创建的元素具有position:absolute;
,以便使此属性以可预测的方式工作,父元素应与position: relatieve;
一起放置。我想让这个组件的未来用户知道这个约束。是否有JSDoc标签用于此目的?您将如何让该组件的用户知道此重要约束?
您需要突出显示您的组件依赖于特定的外部状态。对此没有特定的jsdoc标记,您需要在说明中进行记录。
在jsdoc2md中,您可以声明任意标签,如果有帮助的话-您可以发明自己的标签来对其进行文档化。
自定义标签示例:
/**
* This function has a wonderful custom tag
* @createdIn Nigeria
*/
function customTaggedFunction () {}
产生此输出:
此功能具有出色的自定义标签
种类:全局函数Createdin:尼日利亚