jsdoc

Используя JSDoc, как я могу документировать этот код? var mynamespace = {}; /** * What do I put here? */ mynamespace.myfunc = (function () { var i = 0; /** * Do I need to put anything here? */ return function (a) { return a + i++; }; }()); Подпись в этом случае может бы...

Фон У меня есть проект в Nodejs, использующий классы ECMA6, и я использую JSDoc для комментария моего кода, чтобы сделать его более доступным для других разработчиков. Однако мои комментарии не очень хорошо принимаются инструментом, и моя документация-это крушение поезда. Задача Моя проблема заключае...

Есть ли документация для того, что JSDoc подмножество, суперсеть или смесь двух IntelliJ поддерживает? Моя мотивация для использования JSDoc двоякая: для разработчиков: таким образом, IntelliJ может обеспечить лучшее завершение кода, проверку кода, проверку ошибок и т. д. для повышения эффективности выполн...

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } но как я могу описать, как объект параметров должен быть структурирован? Например, это должно быть что-то вроде: { settin...

как я могу рассказать JSDoc о структуре возвращаемого объекта. Я нашел @return {{field1: type, field2: type, ...}} description синтаксис и попытался это: /** * Returns a coordinate from a given mouse or touch event * @param {TouchEvent|MouseEvent|jQuery.Event} e * A valid mouse or touch event...

согласно JSDoc wiki для @param вы можете указать, что @param является необязательным с помощью /** @param {String} [name] */ function getPerson(name) { } и вы можете указать param inline используя function getPerson(/**String*/ name) { } и я могу объединить их следующим образом, который работае...

скажем, у вас есть что-то вроде следующего: var someFunc = function() { // do something here with arguments } Как бы вы правильно документ, что эта функция может принимать любое количество аргументов в JSDoc? Это моя догадка, но я не уверен, что это правильно. /** * @param {Mixed} [...] Unlimited amo...

в JSDoc лучшая документация, которую я могу найти, показывает, что вы используете следующее, Если у вас есть массив определенного типа (например, массив строк): /** * @param {Array.<string>} myStrings All my awesome strings */ function blah(myStrings){ //stuff here... } Как бы вы заменили ни...