3

我有以下 Moo 课程：


Nem.Ui.Window = new Class({
    Implements: [Options, Events],

    options: {
        caption:    "Ventana",
        icon:       $empty,
        centered:   true,
        id:         $empty,
        width:      $empty,
        height:     $empty,
        modal:      false,
        desktop:    $empty,
        x:          $empty,
        y:          $empty,
        layout:     $empty
    },

    initialize: function(options)
    {
        this.setOptions(options);
        /* ... */
    },

    setHtmlContents: function(content)
    {
        /* ... */
    },

    setText: function(text)
    {
        /* ... */
    },

    close: function(win)
    {
        /* ... */
    },

    /* ... */
});

我想用 JsDoc 记录它。我读到你可以@lends [class].prototype在里面使用new Class并initialize用@constructs标签标记。如何标记方法和事件？

IE：setHtmlContents应该是一个方法，close应该是一个事件。

此外，是否可以options以某种方式记录下的元素？

4

2 回答 2

5

您可以用 标记方法@function和用 标记事件@event，但是由于默认情况下@function可以正确检测到函数，因此在您的情况下不需要标记。

下面的元素options可以用 来记录@memberOf，在你的例子中用@memberOf Nem.Ui.Window#. 然后它们将显示options.optionName在生成的 JSDoc 中。

您的课程的完整文档版本将类似于

/** @class This class represents a closabe UI window with changeable content. */
Nem.Ui.Window = new Class(
/** @lends Nem.Ui.Window# */
{
    Implements: [Options, Events],

    /** The options that can be set. */
    options: {
        /**
         * Some description for caption.
         * @memberOf Nem.Ui.Window#
         * @type String
         */
        caption:    "Ventana",
        /**
         * ...
         */
        icon:       $empty,
        centered:   true,
        id:         $empty,
        width:      $empty,
        height:     $empty,
        modal:      false,
        desktop:    $empty,
        x:          $empty,
        y:          $empty,
        layout:     $empty
    },

    /**
     * The constructor. Will be called automatically when a new instance of this class is created.
     *
     * @param {Object} options The options to set.
     */
    initialize: function(options)
    {
        this.setOptions(options);
        /* ... */
    },

    /**
     * Sets the HTML content of the window.
     *
     * @param {String} content The content to set.
     */
    setHtmlContents: function(content)
    {
        /* ... */
    },

    /**
     * Sets the inner text of the window.
     *
     * @param {String} text The text to set.
     */
    setText: function(text)
    {
        /* ... */
    },

    /**
     * Fired when the window is closed.
     *
     * @event
     * @param {Object} win The closed window.
     */
    close: function(win)
    {
        /* ... */
    },

    /* ... */

});

我跳过了@constructsatinitialize因为它根本不会出现在文档中，而且我还没有弄清楚如何让它正常工作。

有关可用标签及其功能的更多信息，请参阅jsdoc -toolkit wiki上的TagReference。

于 2013-02-12T23:38:13.497 回答
0

我终于通过使用 Natural Docs 解决了这个问题。

于 2010-06-10T01:31:18.017 回答