Vyhledávání na webu

reactjs - @internal JavaScript dokumentační značka uvnitř kódu React, je to jsdoc, closure, nebo něco jiného?


Všiml jsem si, že React používá tag @internal pro dokumentaci. Jaký program tento tag zpracovává? Je to jsdoc nebo něco jiného? Google Closure Compiler? Nemohu tento tag najít na http://usejsdoc.org/ ani v dokumentaci Google Closure Compiler. K čemu se používá?

Zde je příklad -

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

Odpověď č. 1

Kompilátor TypeScriptu může tuto značku použít k vyloučení věcí ze souboru s definicí d.ts.

Podívejte se na možnost --stripInternal pro více informací.

Odpověď č. 2

Z toho to vypadá, že dokumentace je manuální.