Правильные теги для объектов в jsdoc

Question

Как правильно документировать объекты этого стиля в jsdoc:

/**

*/

var strings = 
{
    /**

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

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

А именно, правильный параметр для определения объекта и для распознавания подфункций как части «строк». Я знаю о @param, @return и т. Д., Я просто не знаю основного определения этого типа объектов.

Answer 1

Хотя существуют хорошие аргументы для определения функций-членов объекта путем установки прототипа, иногда это нецелесообразно. Я думал, что выложу ответ, который не пересматривает код. Он использует ту же идею, что и ответ @ Джонатана.

/**
 * @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 был именно тем, что я хотел.

Answer 2

Я бы использовал @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();