@internal JavaScript文档标签内部的反应代码,是这个jsdoc,闭包还是别的什么?

时间:2015-02-18 16:27:03

标签: javascript reactjs google-closure-compiler google-closure jsdoc

我注意到React使用@internal标记来记录文档。什么程序使用此标签?是jsdoc还是其他什么?谷歌闭包编译器?我在http://usejsdoc.org/或Google Closure Compiler文档中找不到此标记。它用于什么?

这是一个例子 -

/**
 * 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

2 个答案:

答案 0 :(得分:0)

this开始,文档似乎是手动的。

答案 1 :(得分:0)

typescript编译器可以使用此标记从d.ts定义中排除内容。

有关详细信息,请参阅--stripInternal option