Документация по Javascript - PullRequest
       1

Документация по Javascript

16 голосов
/ 12 января 2012

Есть ли что-то вроде JavaDocs для Javascript? Когда я нажимаю Ctrl + пробел в IDE NetBeans в то время как

При написании javascript документация по javascript выходит для указанного объекта. Но эта документация, я думаю, является собственностью Netbeans.

Если мы пишем javascript надлежащим образом с комментариями, Netbeans также создает документы для нашего пользовательского javascript.

Можем ли мы найти такую ​​документацию по javascript за пределами Netbeans? Так что мы можем сослаться на это?

Спасибо за ответ.

Ответы [ 3 ]

12 голосов
/ 12 января 2012

Посмотрите на страницы документации в Mozilla Developer Network (MDN) для статической ссылки:

Тем не менее, я боюсь, что в IDE нельзя использовать завершение табуляции.

8 голосов
/ 08 августа 2012

В исходном коде Google своих рисунков на главной странице они используют комментарии, которые очень похожи на комментарии javadoc, поэтому должен быть какой-то стандарт, который, по крайней мере, использует Google.

Вот пример:

/**
 * Configuration for a simulator speed setting.
 * - stepTime: ms between simulation steps that do something.
 * - emptyStepTime: ms between no-op steps.
 * - tapeTime: ms for a tape operation.
 * - branchTime: ms for a branch operation.
 * @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number,
 *            branchTime: number}}
 * @private
 */
0 голосов
/ 23 апреля 2013

Попробуйте приложение под названием Ortelius. Для создания документации используется синтаксис типа javadoc. ortelius.marten.dk

...