Question

我想为javascript文件集合生成文档。

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

function getNullString(){...}

课程中的方法有效：

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

/**
* 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”，但至少您的方法也会出现在文档中。

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

1 个答案: