@internal react 代码中的 JavaScript 文档标签,是 jsdoc、闭包还是其他什么

@internal JavaScript documentation tag inside react code, is this jsdoc, closure, or something else?

本文关键字:jsdoc 闭包 什么 其他 标签 代码 react 文档 JavaScript @internal      更新时间:2023-12-31

我注意到 React 在文档中使用了 @internal 标签。 哪个程序使用此标记? 是jsdoc还是别的什么? 谷歌闭包编译器? 我在 http://usejsdoc.org/或Google闭包编译器文档中找不到此标签。 它的用途是什么?

这是一个例子——

/**
 * Warn for mutations.
 *
 * @internal
 * @param {object} object
 * @param {string} key
 */
function defineWarningProperty(object, key) {

https://github.com/facebook/react/blob/master/src/classic/element/ReactElement.js

打字稿编译器可以使用此标签从 d.ts 定义中排除内容。

有关详细信息,请参阅 --stripInternal 选项。

由此看来,文档是手动的。