如何使用yuidoc注释记录独立函数

Question

我想为一组javascript文件生成文档。

我正在尝试用yuidoc生成，但我不知道如何记录独立的函数。

function getNullString(){...}

类中的方法工作正常：

/**
* ArgumentBuilder
*
* @class argumentBuilder
* @argumentBuilder
*/
function argumentBuilder () {
    /// <summary>Clase utilizada para lo relacionado con funciones del constructor de arguemtnario</summary>
};

/**
* Explanation of the method
*
* @method getComponents
*/
argumentBuilder.getComponents = function (){}

Answer 1

我也有同样的问题。似乎YUIDocs只准备“读取”类/模块工作流。我的解决方案是创建一个虚构的类，然后用@method注释记录其中的函数。

想象一个ini.js文件，在它上面你可以创建一个@class注解：

/**
Main application init functions
@class init
*/

然后在函数上使用@method注释：

/**
My function description here
@method myFunctionName
*/

这样做确实会在文档中创建一个“无效”的类"init“，但至少您的方法在文档中看起来也是有文档记录的。