Документация Javascript
Есть ли что-то вроде JavaDocs для Javascript? Когда я нажимаю Ctrl + пробел в среде netbeans, когда
написание javascript, документация javascript выдается для указанного объекта. Но эта документация - это свойство Netbeans.
Если мы будем писать javascript надлежащим образом прокомментированным способом, Netbeans будет создавать документы для нашего пользовательского javascript тоже.
Можно ли найти такую документацию javascript, вне Netbeans? Чтобы мы могли ссылаться на него?
Спасибо за ответ.
Ответы
Ответ 1
Посмотрите на страницы документа в Mozilla Developer Network (MDN) для статической ссылки:
Однако я боюсь, что в среде IDE нет возможности пополнения табуляции.
Ответ 2
В исходном коде Google на домашней странице doodles они используют комментарии, которые очень похожи на комментарии 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
*/
Ответ 3
Попробуйте приложение под названием Ortelius. Он использует какой-то синтаксис javadoc для генерации документации.
ortelius.marten.dk