在yuidoc javascript documentor中忽略標簽

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列表進行更改。