Есть ли способ сделать @property частным?Сделать @property private
/**
*
* @property {Object} shouldBePrivate but how?
*
*/
...
Я использую jsdoc3
Я хочу, чтобы иметь возможность создавать My Documentation два раза, один с частными свойствами, перечисленными и другой без личных свойств, перечисленных.
Используйте тег @private в JSDoc. Генератор HTML имеет возможность включать или не включать частных членов, поэтому вы можете создавать свои документы один раз с одним и без него.
Как это:
/**
* Lore Ipsum and stuff
* @property {foo}
* @private
*/
Это не работает с свойствами только по переменным, методам, модулям и пространствам имен. Я не хочу, чтобы весь мой модуль был закрыт, а только некоторые свойства внутри него. – Hoffmann
Я не нашел никакой документации по этому поводу. Но опять же, последняя кодовая база, над которой я работал, не использовала этот тег, поэтому я не знаю. Мне жаль, что решение в моем ответе не работает, и теперь мне любопытно найти тот, который делает. – Renan
Да, я начинаю думать, что сейчас нет способа сделать это. – Hoffmann
Просто добавьте тег @private
/**
*
* @property {Object} shouldBePrivate but how?
* @private
*/
@private тег отмечает символ как частные, или не предназначены для общий использование. Частные члены не отображаются в сгенерированном выпуске, если только JSDoc запускается с ключом -p или -private.
Так, просто запустите
jsdoc --private file.js
или
jsdoc -p file.js
включать частные символы в документации file.js и JSDoc без опций, чтобы исключить их.
Вы имеете в виду, что собственность отображается как конфиденциальная с точки зрения jsdoc3? Объясните, что вы подразумеваете под «частным», потому что свойства не могут быть точно частными. – Ian
http://usejsdoc.org/tags-private.html? – lifetimes
Частный - каким образом? Таким образом, свойство игнорируется jsdoc? –