jjzjj

javascript - 如何在yuidoc中添加外部链接(grunt-contrib-yuidoc)

我想我在yuidoc文档中遗漏了一些东西或者误解了用法。我似乎找不到在我的文档中包含指向外部站点/页面的链接的方法。在评论区,我想要这样的东西:/***Createsablah-blahforblah-blahingblah.**@constructor*@param{object}blah**Followrecommendationsat:*@linkBoop*/ 最佳答案 根据文档说:YUIDocsupports3mainformsofformattingyourdocumentation.HTML,Markdown&Selle

javascript - 如何记录方法的 "object"参数

我正在尝试使用YUIDoc为JavaScript方法编写一些文档。看起来像:/**ReturnsaninstanceofclassName@methodgetInstance@param{string}classNametheoftheclassusedtocreatetheinstance@param{Object}optionstheseareoptionsusedtocreatetheinstance**/functiongetInstance(className,options){.....}现在,选项对象可以有多个参数,如options.id、options.single等。

javascript - YUIDocs 中类和模块的文档

我在为一组分组模块编写文档时遇到了一些麻烦。我认为这在一定程度上是对@class、@module和@namespace代表什么的误解。(或者这可能是雅虎试图将“经典”语言词汇硬塞进JS的结果。)我在下面有一个粗略的示例,显示了我的大部分代码是如何编写的,以及我尝试以YUIDoc风格记录它。前两部分(Foo和BazManager)非常简单。对我来说:Foo是一个@class;Baz是一个@class;BazManager是一个@module(或者可能是一个只包含@static成员的@class);Qux也是一个@module但只包含方法。我的问题是:如果BazManager是一个@mod

windows - ANT 脚本不工作

我有一个通过命令行运行yuidoc的ANT脚本,但是当我运行这个脚本时它给我以下错误:[exec]'yuidoc'isnotrecognizedasaninternalorexternalcommand,[exec]operableprogramorbatchfile.和相同的命令->yuidoc-cyuidoc.json。工作然后我通过cmd提示符运行它。我的ANT脚本: 最佳答案 替换executable="cmd"与executable="${pathto/yuidoc}/yuidoc.exe"例子:executable="$

javascript - 如何在 YUIDoc 生成的文档中定义自定义主页

我一直在玩YUIDoc我觉得太棒了。顺便说一下,我没有找到一种方法来为自动生成的文档站点定义我自己的主页内容(自动生成的index.html中的自定义内容)。如何定义主页内容-当然可以-?提前致谢! 最佳答案 YUIDoc非常适合主题化,所以理论上这应该很容易:ForkYUIDoc或修改您当前的YUIDoc安装。在yuidoc/themes下添加您自己的主题。复制默认主题可能是开始的好地方,或复制您要覆盖的部分/文件。在index.handlebars您添加自定义内容。您还可以更改main.handlebars包括自定义CSS、JS