我的一个类生成了一个 jsDoc 错误,因为它正在扩展 goog.Disposable。我正在使用@extends 来指定这一点,但它仍然无法正常工作。使用闭包 linter 编译文件时不会出错。代码可以在这里找到”
问问题
305 次
1 回答
1
您的 JavaScript 文件包含以下行:
goog.inherits(goog.Disposable, niuzly.base.errorHandler);
goog.inherits接受子构造函数,后跟父构造函数:
goog.inherits(niuzly.base.errorHandler, goog.Disposable);
对于JSDoc-Toolkit模板,您可以尝试gcodewiki。使用 gcodewiki,我成功为您的文件niuzly.base.errorHandler.js生成了 JSDoc,并带有以下警告:
>> WARNING: Trying to document errorHandler as a member of undocumented symbol niuzly.base.
>> WARNING: Can't augment contributer: goog.Disposable, not found.
包括闭包库base.js
和disposable.js
作为 JSDoc-Toolkit 的输入消除了警告Can't augment contributer: goog.Disposable, not found.
要消除有关 undocumented symbol 的警告niuzly.base
,您可以将以下内容添加到源文件中,或者忽略警告。
/**
* @type {Object} Namespace for Niuzly Inc.
*/
var niuzly = niuzly || {};
/**
* @type {Object} Base namespace.
*/
niuzly.base = niuzly.base || {};
JSDoc 3
当仅指定niuzly.base.errorHandler.js和disposable.js时,使用JSDoc 3而不是旧的 JSDoc-Toolkit 成功生成了文档。此外,没有关于未记录符号的警告。niuzly.base
于 2012-08-17T17:00:06.397 回答