0
ответов
Есть ли способ избежать использования аннотации JSDoc «@method»
Лично я не являюсь большим поклонником сгенерированной документации (. Я больше люблю "читать исходный код Люка" ), но я вижу, как такая документация может быть полезна другим. Теперь обычно их...
вопрос задан: 26 July 2012 21:33
0
ответов
Как документировать возврат в JavaScript
Я пишу свою собственную библиотеку для проекта на работе для приложения браузера, и у меня есть та же старая проблема, решая, как комментировать код. Я пытаюсь следовать синтаксису JsDoc, но буду...
вопрос задан: 20 June 2012 10:10
0
ответов
Тип регулярного выражения для компилятора замыкания
В настоящее время я добавляю аннотацию типа в личный модуль javascript, но сейчас я застрял при попытке ввести функцию, принимающую регулярное выражение в качестве параметра, но ни одна из следующих попыток не работает: ...
вопрос задан: 1 June 2012 05:03
0
ответов
Как избежать знака @ внутри комментариев JSDoc в NetBeans
У меня есть простой метод в API, который позволяет искать объекты с помощью JSONPath. Поскольку его синтаксис практически незнаком младшим разработчикам, я решил привести несколько примеров в комментарии JSDoc. Тем не менее,...
вопрос задан: 19 April 2012 08:01
0
ответов
Вопросы о документировании данных вложенных массивов и объектов с помощью jsDoc
Как сделать Я форматирую вложенные массивы и объекты с помощью jsdoc? Это мое лучшее предположение: an_obj = {username1: [{param1: "value 1-1-1", param2: "value ...
вопрос задан: 20 February 2012 16:53
0
ответов
Как документировать анонимные функции (закрытие) с помощью jsdoc-toolkit
Я пытаюсь задокументировать свой код с помощью JSDoc-toolkit. Мой код начинается с того, что он оборачивается самоисполняющейся анонимной функцией. Как я могу это задокументировать? Я потратил на это почти весь день. ...
вопрос задан: 10 November 2011 05:31
0
ответов
Как документировать пространства имен в JavaScript?
Как можно документировать пространства имен в JavaScript с помощью jsDoc? Вот моя попытка, правильно? / ** * Мое специальное пространство имен * * @name my.namespace * @namespace * /
$ namespace ('my.namespace', / ** @ ...
вопрос задан: 26 August 2011 15:31
0
ответов
оболочка linux добавляет параметры переменных в команду
Я пытаюсь получить сценарий bash, который генерирует JSDoc для заданных параметров, подобных этому ./jsdoc .sh file.js another.js might-a-third.js Я застрял в том, как передать неизвестное количество ...
вопрос задан: 5 August 2011 22:02
0
ответов
JSDoc Toolkit - Как указать @param и @property в одной строке
Есть ли способ избежать ввода двух отдельных строк для @property и @param if, как в Например, в конструкторе параметры и свойства имеют идентичные имена. / ** * Класс для ...
вопрос задан: 25 June 2011 07:19
0
ответов
Как описать аргументы «объекта» в jsdoc?
// Моя функция выполняет X и Y.
// @params {object} параметры Объект, содержащий параметры
// @params {функция} обратный вызов Функция обратного вызова
функция (параметры, обратный вызов) {
} Но как мне ...
вопрос задан: 23 June 2011 10:06
0
ответов
Ahoana ny fomba anoratan'i jsdoc ny kaody BackboneJS?
Efa nisy olona nanoratra ny kaody BackboneJS niaraka tamin'i JSDoc? Manan-java-manahirana amin'ny fanamarihana ny fanamboarana Backbone toy ny: User = Backbone.Model.extend ({default: {a: 1}, fanombohana: function () ...
вопрос задан: 22 June 2011 11:16
0
ответов
Почему jQuery не использует JSDoc? [закрыто]
Или они есть и этого просто нет в источнике? Я бы очень хотел получить что-то, что остановит js-doc-toolkit от волнения каждый раз, когда он анализирует jQuery. Это также означает, что я не могу должным образом задокументировать ...
вопрос задан: 31 May 2011 22:07
0
ответов
How to indicate param is optional using inline JSDoc?
According to the JSDoc wiki for @param you can indicate a @param is optional using /** @param {String} [name]
* /
function getPerson (name) {
} и вы можете указать встроенный параметр с помощью ...
вопрос задан: 15 May 2011 14:59
0
ответов
Использование тега @typedef Google Closure
Компилятор Google Closure имеет тег "@typedef", но можно ли использовать его в своем коде? (Я знаю, что это сработает, но не одобряют ли это?) Итак, вот мой тип / ** * typedef объекта плана * @typedef {...
вопрос задан: 10 May 2011 11:44
0
ответов
Документирование класса javascript с прототипами в пространстве имен с помощью jsdoc-toolkit
I ' m очень стараюсь документировать код в формате ниже, используя jsdoc-toolkit. Мне кажется, что используемые мной теги должны дать желаемый результат, но это не так. Вместо этого он предупреждает, что Class - это ...
вопрос задан: 11 April 2011 09:14
0
ответов
Почему компилятор Closure не распознает объявления типов внутри самоисполняющейся анонимной функции?
Я получаю много предупреждений «Неизвестный тип» при запуске довольно большой библиотеки через компилятор Closure, и они кажутся когда мои типы объявлены в самоисполняющихся анонимных функциях. ...
вопрос задан: 3 March 2011 05:52
0
ответов
Как сделать JsDoc & ldquo; смешанный & rdquo; тип?
Простой вопрос, как мне документировать этот «смешанный тип»? Я знаю, что мог бы просто перечислить все возможные типы, такие как {null | undefined | String | Number | Object}, и в итоге я обнаружил, что пропустил один и сделал это слишком ...
вопрос задан: 5 February 2011 19:47
0
ответов
Как использовать множественное наследование JsDoc или миксины?
Как мне документировать миксины или множественное наследование? / ** * @ родительский класс * /
function Parent () {
} Parent.prototype.parentTest = 5; / ** * @class Mixin * /
function Mixin () {
} Mixin.prototype ....
вопрос задан: 30 January 2011 14:54
0
ответов
Как вернуть void в JsDoc?
Есть ли указанный способ объявить метод или функцию для возврата void в JsDoc? В настоящее время я считаю, что void является возвращаемым значением по умолчанию, а другие возвращаемые значения должны быть специально ...
вопрос задан: 21 January 2011 13:21
0
ответов
100% типизированный компилятор Google Closure
Как я могу получить 100% типизацию моего приложения в отношении компилятора закрытия Google? Я уже все пометил комментариями jsdoc. Возможно ли вообще получить 100? У меня 64,6%
вопрос задан: 19 November 2010 23:33
0
ответов
Поддержка JSDoc в IntelliJ IDEA
Есть ли документация о том, какое подмножество, надмножество или сочетание двух JSDoc поддерживает IntelliJ? У меня двоякая мотивация к использованию JSDoc: Для разработчиков: чтобы IntelliJ мог обеспечить лучшее завершение кода, ...
вопрос задан: 3 November 2010 22:42
0
ответов
Вставить относительную ссылку в reStructuredText
Я документирую библиотеку, которая имеет компонент Python и компонент JavaScript. Вся пользовательская документация и документация по Python API находятся в reStructuredText, обработанном с помощью Sphinx. ...
вопрос задан: 7 October 2010 00:09
0
ответов
Как документировать переменное количество параметров
Как мне документировать переменное количество параметров? Я пишу приложение на PHP и JavaScript. В настоящее время у меня есть (в JavaScript): / ** * Описание * @param {String} описание * /
функция fn ()
{...
вопрос задан: 28 August 2010 10:48