JSDoc有一个@readonly doclet tag：

The @readonly tag indicates that a symbol is intended to be read-only.

例如：

/**
* The name of the represented principal
* @member {string}
* @readonly
*/
this.name = primaryName;

但是,我真正想要传达和记录的是公共消费者应该将该属性视为只读 – 但该成员不是常量.

内部代码可以并且确实修改了这些成员：只读doclet标记用于API使用者. (如果API使用不正确,请对它们感到羞耻！ – 但不是我的顾虑.)

/**
* Update the security token information.
* (This is a made-up example!)
*/
this.updateToken = function (token) { this.name = token.name; }

有没有一种在JSDoc(标签)中表达这个概念的好方法？特别是,

什么是表达“预计内部代码会修改此只读成员”的好方法？

除了doclet标签之外,在文档当然没有明确写出来.

我本来希望JSDoc可以简单地接受“@readonly private”或者类似的东西,但事实并非如此.使用自定义标签的问题是这样的问题是在本地引入的,在标准模板中没有迫在眉睫的外部意义或应用.

解决方法:

不幸的是,没有像多个标签.

喜欢“@ readonly,private”不存在.

因此,您可以使用@readonly或@private中的任何一个,但您正在寻找的是目前无法/可用的东西(据我所知).