Question

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

/**

*/

var strings = 
{
    /**

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

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

即定义对象的适当参数，并将子函数识别为“字符串”的一部分。我知道@param，@return等，我只是不知道这类对象的主要定义。

Answer 1

我会将@namespace用于“strings”

这些方法只会使用@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();

Answer 2

虽然通过设置原型来定义对象成员函数有很好的参数，但有时这是不切实际的。我以为我会发布一个不会重新考虑代码的答案。它使用与@ Jonathan的答案相同的想法。

/**
 * @namespace
 * Custom String functions
 */
var strings = 
{
    /**
     * Strips the HTML away
     */  
    stripHTML: function(html)
    {
        //does something
    },

    /**
     * Ensures the HTML is valid
     */
    validHTML: function(html)
    {
        //does something else
    }
}

来自JSDoc-Toolkit的例子正是我所追求的。

jsdoc中对象的正确标签

2 个答案: