标签：javascript documentation readonly jsdoc jsdoc3

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中的任何一个,但您正在寻找的是目前无法/可用的东西(据我所知).

标签：javascript,documentation,readonly,jsdoc,jsdoc3
来源： https://codeday.me/bug/20190728/1560729.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。