Как JSDoc методы вложенного объекта?

вот простой способ сделать это:

/**
 * @module mystuff/foo
 * @version 1.0
 */
define([], function() {

/** @lends module:mystuff/foo */
var foo = {
    /**
     * A method in first level, just for test
     */
    testFirstLvl: function(msg) {},
    /**
     * @namespace
     */
    bar4: {
        /**
         * This is the description for baz4.
         */
        baz4: function() { /*...*/ },
        /**
         * This is the description for test.
         */
        test : true
    }
};

return foo;
});

обратите внимание, что jsdoc может вывести типы baz4.baz4 и test без необходимости говорить @method и @member.

поскольку jsdoc3 помещает документацию для классов и пространств имен в то же самое страница как модуль, который определяет их, я не знаю, как это сделать.

Я использую jsdoc3 в течение нескольких месяцев, документируя небольшая библиотека и большие приложения С ним. Я предпочитаю сгибаться под волю jsdoc3 в некоторых областях, чем набирать пачки @ - директив, чтобы согнуть его под мою волю.

вы не можете напрямую документировать вложенные функции. Мне не понравилось решение Prongs, поэтому я использовал другую реализацию без пространств имен (это JS,не Java!).

обновление:

я обновил свой ответ, чтобы отразить точный случай использования, данный OP (что справедливо, поскольку JSdoc довольно болезненно использовать). Вот как это будет работать:

/** @module foobar */

/** @function */
function foobarbaz() {
    /* 
     * You can't document properties inside a function as members, like you
     * can for classes. In Javascript, functions are first-class objects. The
     * workaround is to make it a @memberof it's closest parent (the module).
     * manually linking it to the function using (see: {@link ...}), and giving
     * it a @name.
     */

    /**
     * Foo object (see: {@link module:foobar~foobarbaz})
     * @name foo
     * @inner
     * @private
     * @memberof module:foobar
     * @property {Object} foo - The foo object
     * @property {Object} foo.bar - The bar object
     * @property {function} foo.bar.baz - The baz function
     */
    var foo = {

        /* 
         * You can follow the same steps that was done for foo, with bar. Or if the
         * @property description of foo.bar is enough, leave this alone. 
         */
        bar: {

            /*
             * Like the limitation with the foo object, you can only document members 
             * of @classes. Here I used the same technique as foo, except with baz.
             */

            /**
             * Baz function (see: {@link module:foobar~foo})
             * @function
             * @memberof module:foobar
             * @returns {string} Some string
             */
            baz: function() { /*...*/ }
        }
    };

    return foo;
}

к сожалению, JSdoc является портом Java, поэтому у него есть много функций, которые имеют смысл для Java но не для JS, и наоборот. Например, поскольку в JS функции являются первоклассными объектами, их можно рассматривать как объекты или функции. Поэтому делать что-то подобное должно работать:

/** @function */
function hello() {
  /** @member {Object} */
  var hi = {};
}

но это не будет, потому что JSdoc распознает его как функцию. Вам придется использовать пространства имен, мою технику с @link, или сделать его класс:

/** @class */
function Hello() {
  /** @member {Object} */
  var hi = {};
}

но тогда это не имеет смысла. существуют ли классы в JS? нет, они этого не делают.

Я думаю, что нам действительно нужно найти лучшее решение для документации. Я даже видел несоответствия в документации для того, как должны отображаться типы (например,{object} vs {Object}).

вы также можете использовать мою технику в документе закрытие.

просто улучшить ответ Зубцов немного для JSDoc3, я смог заставить его работать только тогда, когда я использовал @ instance аннотация вместо @member.

пример кода ES6:

class Test
{
    /**
     * @param {object} something
     */
    constructor(something)
    {
        this.somethingElse = something;

        /**
         * This sub-object contains all sub-class functionality.
         *
         * @type {object}
         */
        this.topology = {
            /**
             * Informative comment here!
             *
             * @alias topology.toJSON
             * @memberof! Test#
             * @instance topology.toJSON
             * 
             * @returns {object} JSON object
             */
            toJSON()
            {
                return deepclone(privatesMap.get(this).innerJSON);
            },


            ...
        }
    }
}