问题标签 [yuidoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
javascript - 如何记录方法的“对象”参数
我正在尝试使用 YUIDoc 为 JavaScript 方法编写一些文档。看起来像:
现在,options 对象可以有多个参数,例如options.id
,options.single
等。
如何将此信息添加到 this 的文档中@param
?
javascript - 如何判断我的方法接受 yuidoc 中的 {id: String, label: String} 数组?
我无法在文档中找到它。
我更喜欢[{id: String, label: String}]
在生成的文档中显示类型,并且实验让我认为我唯一能做的就是指定一个没有任何其他字符的纯字母数字字符串(它们被生成器忽略)。
真的没有办法吗?
javascript - 如何在 YUIDoc 生成的文档上定义自定义主页
我一直在玩YUIDoc,我觉得它很棒。
顺便说一句,我找不到为自动生成的文档站点定义我自己的主页内容(自动生成的自定义内容index.html
)的方法。
我如何定义主页内容——当然,如果可能的话——?
先感谢您!
javascript - yuidoc - 如何在其他文件中定义类方法
我正在用 yuidoc 编写文档。但是,我有一个模型类,它在别处定义了它的一个方法。这是一些可视化情况的代码。假设我有一个文件 model.js:
还有一个文件 activerecord.js:
如您所见,“hasMany”方法应该出现在 Model 的类文档下。然而,事实并非如此。这样的事情可能吗?
非常感谢
yuidoc - 如何为 yuidoc 添加 IgnorePath
在生成文档表单 yuidoc 时,我想忽略我项目的 lib 文件夹中下载的 javascript 库。我怎样才能把它放到我试过的忽略列表
"ignorePaths": [ "./lib" ]
中
"ignorePaths": [ "./lib/*.js" ]
,,
"ignorePaths": [ "lib" ]
它仍然在编译我的 javascript 库文件。
javascript - Yuidoc : 指定参数的性质
我正在尝试使用 yuidoc ( http://yui.github.io/yuidoc/ ) 记录我的 node.js 模块,我想知道如何创建从参数到其实现的链接。
假设我有以下src/core/Repo.js
还有一个src/routing/Routes.js
我如何告诉Routes
函数接受一个Repo
对象的参数,以便让 yuidoc 在 html 文档中生成正确的超链接?(上面的片段似乎不起作用)
ruby - Ruby 中的 Yuidoc 风格的注释?
如何在 Ruby 中使用 YUIDoc 注释?我能想到的最好的是:
和这个:
javascript - 如何在 YuiDoc 中记录重载方法?
假设我有一个类 foo 上的方法,它有一个方法 bar,它接受所有可选参数,但如果参数和顺序发生变化,则方法的返回值会发生显着变化。
如何表示在 yuidoc 中调用此方法的不同方式?
可选参数没问题,但是如果我把它都放在那里,方法描述会有点长。
javascript - 使用 yuidoc 和 ANT 脚本生成 JavaScript 文档
我正在尝试使用 yuidoc 生成 JavaScript 文档,下面是我的 ANT 脚本。
我的项目看起来像
运行 ANT 脚本时出现错误:
windows - ANT 脚本不工作
我有一个通过命令行运行 yuidoc 的 ANT 脚本,但是当我运行这个脚本时,它给了我以下错误:
和相同的命令 -> yuidoc -c yuidoc.json 。工作,然后我通过 cmd 提示符运行它。
我的 ANT 脚本: