javascript - 在 yuidoc javascript文档文档中,忽略标记

  显示原文与译文双语对照的内容
0 0

是否可以忽略yuidoc中的各种标记以使文档生成过程消息更加有用。

我对 @author, @date 等标签有问题

/**
 * The XYZ View.. . 
 * These tags yuidoc result in a yuidoc warning
 * 
 * @company <company name>
 * @date Mon Aug 27 2013 22:30:50 GMT+0200 (CEST)
 * 
 * These tags yuidoc is able to interpret
 * @author Bernhard <email@foo>
 * @module Welcome 
 * @submodule Frontend
 * @class WelcomeView
 * @constructor
 *
 */
//Yuidoc throws warnings like
 warn: (docparser): unknown tag: company, path/to/file.js:1
 warn: (docparser): unknown tag: date, path/to/file.js:1:1

有很多文件,这使得无法找到"真实"警告"是否有方法去除yuidoc中的标签。

时间:原作者:1个回答

0 0

基于我所做的研究,YUIDoc无法设置标记列表,以便忽略这些警告。

但是,你可以执行以下操作:

  1. ( 可选) 派生现有 YUIDoc项目
  2. 编辑 yuidocjs/lib/docparser.js,并将所需的标记添加到 TAGLIST:

    TAGLIST = [
    //...
    "conditional",//conditional module
    "company",
    "config",//a config param (not an attribute, so no change events)
    //...
    "contributor",//like author
    "date",
    "default",//property/attribute default value
    //...
    ]
  3. 正常运行 YUIDoc,并注意警告消失 !

注意这些字段不会出现在文档中,但是看起来你主要关注的是如何忽略警告。 如果你要处理标记,你需要对 DIGESTERS 列表进行更改。

原作者:
...