Закрытие linter warning о интерфейсах

Question

Я использую компилятор замыкания, и у меня есть два класса, которые, как я хотел бы утверждать, имеют минимальный набор методов/свойств. Для достижения этой цели, я создал интерфейс ... т.д .:

goog.scope(function() { 



/** 
* @interface 
*/ 
namespace.Foo = function() {}; 
var Foo = namespace.Foo 


/** 
* @return {string} 
*/ 
Foo.prototype.bar = function() {}; 

}); // goog.scope 

Проблема заключается в том, что Foo.prototype.bar не имеет return заявления, поэтому закрытие ЛИНТЕР жалуется, даже если само закрытие полностью довольно.

Line 38, E:0218: Found @return JsDoc on function that returns nothing 
Line 56, E:0218: Found @return JsDoc on function that returns nothing 

Конечно, если я удалить @return аннотаций, то закрытие несчастное и бросает предупреждения о переопределении метода и возвращая что-то несовместимое с интерфейсом. Я не хочу отключать это предупреждение, потому что это в значительной степени причина, по которой я написал интерфейс в первую очередь (чтобы убедиться, что все разработчики делают то, что им нужно делать).

Есть ли какое-нибудь магическое заклинание, которое я могу использовать, чтобы отключить это предупреждение в закрытии linter только в этом файле?

Answer 1

Попробуйте следующее:.

/** 
* @return {string} 
*/ 
namespace.Foo.prototype.bar; 

интерфейсы не нужны никакие функции тела вообще я подозреваю, что они могут видеть только компилятором и даже не ветер в вашем коде вообще

.

Или, потому что вы используете goog.scope вы можете написать:

/** 
* @return {string} 
*/ 
Foo.prototype.bar; 

Answer 2

Вы можете попробовать @abstract тег, это может помочь. Если нет, закрывающее устройство может suppress предупреждений. Я думаю, что что-то вроде этого будет работать.

/** 
* @return {string} 
* @suppress {missingReturn} 
*/ 
Foo.prototype.bar = function() {}; 

Удачи вам!

Answer 3

Оказывается, что ответ был просто ждет, чтобы быть обнаруженным в закрывающем-пухе source code/test cases:

Они пишут что-то вроде:

/** 
* Sample interface to demonstrate correct style. 
* @interface 
*/ 
sample.GoodInterface = function() { 
}; 


/** 
* Legal methods can take parameters and have a return type. 
* @param {string} param1 First parameter. 
* @param {Object} param2 Second parameter. 
* @return {number} Some return value. 
*/ 
sample.GoodInterface.prototype.legalMethod = function(param1, param2) { 
}; 

, по-видимому штраф в Линце своих тестов. Как это отличается от моего? Ну, они не использовали goog.scope, чтобы сделать любое наложение. Когда я снял ступенчатости (например

/** 
* @return {string} 
*/ 
namespace.Foo.prototype.bar = function() {}; 

укупорочное-ЛИНТЕР теперь достаточно умен, чтобы понять, что Foo является частью интерфейса и не требует какого-либо осуществления в методах. Потрясающе.