忽略yuidoc javascript文档中的标记

Question

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

我对诸如“作者”、“日期”等标签有问题

/**
 * 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中释放标签吗？

Answer 1

根据我所做的研究，YUIDoc没有提供任何方法来设置要忽略的标签列表，也没有提供任何其他方法来筛选这些警告。

但是，您可以这样做：

1. (可选)分叉现有的YUIDoc项目
2. 编辑yuidocjs/lib/docparser.js，并将所需的标记添加到TAGLIST： TAGLIST = // .“条件”，//条件模块"company"，" config "，// a config param (不是属性，所以没有更改事件) // .“贡献者”，//类似作者“日期”，“默认”，//属性/属性默认值// .
3. 正常运行YUIDoc，然后看着警告消失！

请注意，这些字段不会出现在文档中，但您的主要关注点似乎是如何省略警告。如果您确实希望处理这些标记，则需要对DIGESTERS列表进行更改。