javascript - 如何使用 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”，但至少您的方法也会出现在文档中。