Javascript 将@property私有化

Javascript 将@property私有化,javascript,documentation,jsdoc,Javascript,Documentation,Jsdoc,有没有办法将@财产私有化 /** * * @property {Object} shouldBePrivate but how? * */ ... 我正在使用 我希望能够生成两次文档,一次列出私有属性,另一次不列出私有属性。使用JSDoc中的@private标记。HTML生成器有一个包含或不包含私有成员的选项,因此您可以一次生成文档,其中包含或不包含私有成员 像这样: /** * Lore Ipsum and stuff * @property {foo} * @private

有没有办法将@财产私有化

/**
 *
 * @property {Object} shouldBePrivate but how?
 * 
 */
...
我正在使用


我希望能够生成两次文档,一次列出私有属性,另一次不列出私有属性。

使用JSDoc中的
@private
标记。HTML生成器有一个包含或不包含私有成员的选项,因此您可以一次生成文档,其中包含或不包含私有成员

像这样:

/**
 * Lore Ipsum and stuff
 * @property {foo}
 * @private
 */

在JSDoc中使用
@private
标记。HTML生成器有一个包含或不包含私有成员的选项,因此您可以一次生成文档,其中包含或不包含私有成员

像这样:

/**
 * Lore Ipsum and stuff
 * @property {foo}
 * @private
 */

只需添加标记@private

/**
 *
 * @property {Object} shouldBePrivate but how?
 * @private
 */

@private标记将一个符号标记为private,或不表示通用 使用。私有成员不会显示在生成的输出中,除非 JSDoc使用-p或--private开关运行

所以,快跑吧

jsdoc --private file.js


要在file.js和jsdoc的文档中包含私有符号,而无需排除它们的选项。

只需添加标记@private即可

/**
 *
 * @property {Object} shouldBePrivate but how?
 * @private
 */

@private标记将一个符号标记为private,或不表示通用 使用。私有成员不会显示在生成的输出中,除非 JSDoc使用-p或--private开关运行

所以,快跑吧

jsdoc --private file.js


在file.js和jsdoc的文档中包含私有符号,而不包含排除它们的选项。

您的意思是让属性在jsdoc3中显示为私有?解释你所说的“私有”是什么意思,因为财产不能完全是私有的?私人-以什么方式?那么这个属性被jsdoc忽略了?@MarkBertenshaw是的,这就是我想要的,Zenith不处理属性。Ian为什么我不能将属性记录为私有(即使它们不在代码中)?我将扩展我的问题,以说明我为什么要这样做,你的意思是让物业在jsdoc3中显示为私有?解释你所说的“私有”是什么意思,因为财产不能完全是私有的?私人-以什么方式?那么这个属性被jsdoc忽略了?@MarkBertenshaw是的,这就是我想要的,Zenith不处理属性。Ian为什么我不能将属性记录为私有(即使它们不在代码中)?我将扩展我的问题,以说明为什么我希望这不适用于仅在变量、方法、模块和命名空间上的属性。我不想让我的整个模块成为私有的,只是其中的一些属性。我没有找到任何关于这方面的文档。但话说回来,我上一次使用的代码库没有使用该标记,所以我不知道。很抱歉,我的答案中的解决方案不起作用,现在我很想找到一个起作用的解决方案。是的,我开始认为目前没有办法这样做。也许用
@private
替换
@property
,并丢弃标记的类型和名称参数会有所帮助?这不仅对变量、方法的属性有效,模块和名称空间。我不想让我的整个模块成为私有的,只是其中的一些属性。我没有找到任何关于这方面的文档。但话说回来,我上一次使用的代码库没有使用该标记,所以我不知道。很抱歉,我的答案中的解决方案不起作用,现在我很想找到一个起作用的解决方案。是的,我开始认为目前没有办法这样做。也许用
@private
替换
@property
并丢弃标记的类型和名称参数会有所帮助?