javascript-jsdoc中对象的正确标签

在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();
上一篇:c#-Discord.Net —如何使用“ @”让Bot Ping用户


下一篇:android-如何在MIFARE Ultralight EV1标签上设置和取消设置密码?