我想为一组 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 (){}
最佳答案
我也遇到了同样的问题。看来 YUIDocs 只准备“读取”类/模块工作流程。我的解决方案是创建一个虚构的类，然后使用 @method 注释记录其上的函数。
想象一个 ini.js 文件，您可以在其顶部创建一个 @class 注释:
/**
Main application init functions
@class init
*/
然后在函数上，使用@method注释:
/**
My function description here
@method myFunctionName
*/
这样做确实会在文档中创建“无效”类“init”，但至少您的方法也会出现在文档中。
关于javascript - 如何使用 yuidoc 注释记录独立函数，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/12686569/