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();

var str=“bob
”；
str=str.stripHTML（）；

虽然通过设置原型来定义对象成员函数有很好的论据，但有时这并不实际。我想我会发布一个不会重新考虑代码的答案。它使用了与@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
    }
}

---

来自：的示例正是我想要的。

谢谢你的回答。我知道原型，但谢谢你的提示。我用作演示的脚本有一些误导性的名称。啊，好吧。好吧，对于作为名称空间的单例，只需使用@namespace。当你有复杂的结构时，这确实是一件痛苦的事，是吗任何标记函数的方法，比如“validHTML”，使其看起来像是“字符串”的方法或链接到“字符串”的方法吗？查看生成的文档，无法真正确定它是此类函数的成员。jsdoc文档生成器并不真正了解内置对象，只了解语法。您可以使用@memberOf来解释冰冷地定义关系在这种情况下，@memberOf不合适，因为saveState不是类的实例化。您需要/**@static*/saveContent:function（）…请参阅