@ требуемая аннотация в файлах JavaScript

Question

Я нахожусь в начальной точке при попытке создать библиотеку JavaScript для нашего приложения RIA на работе.В настоящее время у нас есть много файлов JavaScript с функциями в глобальном масштабе, и я хотел бы попытаться придать нашим функциям разумное пространство имен и контекст.Возможно положить их в форму объекта.

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

/**
 * @required OpenLayers/Map.js
 */

.

Имеет ли это какое-либо значение, кроме как быть комментарием вфайл?Есть ли какой-нибудь способ импортировать другие файлы .js в основную сборку с помощью этой аннотации или оператора импорта, как в Java?

Answer 1

Этот код использует JsDoc (http://jsdoc.sourceforge.net/) или что-то подобное для создания документации из исходного кода, скорее всего.

Javascript на самом деле не имеет аннотаций.

Answer 2

Выберите RequireJS .Это загрузчик файлов и модулей JavaScript.Он реализует предложение CommonJS .

Answer 3

Это комментарий в стиле PHPDoc , говорящий всем, кто работает с кодом, что он не будет работать должным образом без OpenLayers/Map.js

Answer 4

JavaDoc, дедушка всех систем документирования / аннотации кода, для которых получены все остальные (я думаю):

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html