忽略yuidoc javascript文档中的标记

Question

是否可以忽略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中排除标签？

Answer 1

根据我所做的研究，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列表进行更改。