标签: yuidoc

我正在使用YUIdoc.还要别的吗 ？那么有人能告诉我如何在Ember中正确记录模型,控制器,混合和视图吗？

例如,我试图记录这个:

App.newModel = DS.Model.extend({
    someProperty: DS.attr('string')
});

App.myController = Ember.Controller.extend({
    someProperty: ...
});

App.myMixin = Ember.Mixin.create({
    someProperty: ...
});

编辑我现在使用YUIdoc而不是jsdoc3

我正在尝试使用YUIDOC自动生成文档,但我有一个大量使用python的服务器端框架,所以我试图在python脚本中自动化所有内容.我能够让node命令运行正常,但每当我尝试使用npm安装的东西时,python就不高兴了.我的项目使用Buildout而不是virtualenv,但理想情况下我希望能够从一个独立的python文件中运行这些命令.

也许一些代码可以帮助解释我的情况:

import subprocess
subprocess.check_call('node --help')

#SUCCESS

import subprocess
subprocess.check_call('npm --help')

#FAIL
#WindowsError: [Error 2] The system cannot find the file specified

import subprocess
subprocess.check_call('yuidoc --help')

#FAIL
#WindowsError: [Error 2] The system cannot find the file specified

我已经尝试将yuidoc和npm东西所在的文件夹添加到python的sys.path中,但是这不起作用.

ps,这是一个与这个问题类似的问题.

我正在尝试使用YUIDoc为JavaScript方法编写一些文档.看起来像:

/** 
    Returns an instance of className

    @method getInstance
    @param {string} className the of the class used to create the instance
    @param {Object} options these are options used to create the instance
**/
function getInstance(className, options) { ..... }

现在,选择对象可以有几个参数,如options.id,options.single等.

如何将此信息添加到此文档中@param？

我一直在玩YUIDoc,我觉得很棒.

顺便说一句,我找不到为自动生成的文档站点定义自己的主页内容的方法(自动生成的自定义内容index.html).

如何定义主页面内容 - 如果可行的话,当然 - ？

先感谢您!

我想我在yuidoc文档或误解用法中遗漏了一些东西.我似乎找不到在我的文档中包含指向外部站点/页面的链接的方法.

在评论栏中,我想要有这样的东西:

/**
 * Creates a blah-blah for blah-blahing blah.
 * 
 * @constructor
 * @param {object} blah
 *
 * Follow recommendations at:
 * @link <a href="http://blah.com/boop">Boop</a>
 */

当你构建并运行YUIDoc时,它会从中获取一些资源http://yui.yahooapis.com/....这些资源包括样式表和yui.min.js.
如何离线下载和使用这些资源？

原因是我们在HTTPS服务器上运行我们的文档.YUIDoc始终通过HTTP协议提供文件.

根据 YUIdoc 的文档（在本例中似乎相当于 jsdoc），有一个 @throws 标签来记录可能抛出的错误。

指定方法抛出的错误。@throws 标签具有结构@throws {type} 描述。{type} 是可选的。

就我而言，函数中有多个检查可能会引发错误，因此我想用 @throws 列出它们。但您不能拥有多个 @throws 标签。那么如何将可能引发的错误列表放入此标记中呢？