javascript-jsdoc中对象的正确标签

2019-11-07 22:35:10 阅读：426 来源： 互联网

在jsdoc中记录这种样式的对象的正确方法是什么：

/**

*/

var strings = 
{
    /**

    */  
    stripHTML: function(html)
    {
        //does something
    },
    /**

    */
    validHTML: function(html)
    {
        //does something else
    }
}

即是适当的参数,用于定义对象,并将子功能识别为“字符串”的一部分.我知道@ param,@ return等,我只是不知道此类对象的主要定义.

解决方法:

我会使用@namespace作为“字符串”

这些方法将只使用@function(尽管jsdoc很明显它们是什么)

编辑
在您的特定示例中,您可能需要使用以下内容：

/**
    describe purpose
*/
String.prototype.stripHTML = function()
{
    //does something with this
}

/**
    describe purpose
*/
String.prototype.validHTML = function()
{
    //does something else with this
}

然后像这样使用：

var str = "bob<br/>";
str = str.stripHTML();

标签：javascript,documentation,tags
来源： https://codeday.me/bug/20191107/2003672.html

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

ICode9

javascript-jsdoc中对象的正确标签