JavaScript XML Комментарий Документация

Question

Я создаю пользовательскую библиотеку составных элементов управления, которые включают их собственные файлы JavaScript в качестве веб-ресурсов. У меня DocProject работает для генерации моих XML-документации CHM, и она отлично работает.

Однако, когда я установил свое решение для конфигурации «Отпустить», среда выполнения все еще не извлекает комментарии XML из встроенных файлов JavaScript и включает их в сгенерированный файл comments.xml или файл отражения .org. Поэтому, когда я запускаю свою сборку DocProject, комментарии, которые я включил в мои файлы JavaScript, исключены, что делает мою документацию несовершенной.

Любые мысли? Я хотел бы иметь возможность включать документацию JavaScript непосредственно в созданную CHM.

С тех пор я смотрел AjaxDoc на CodePlex и не имел успеха с ним примерно через 6 часов. Да, я уже связался с Бертрандом Лерой (создателем AjaxDoc) и надеюсь услышать что-то, хотя я уверен, что он довольно занят.

Answer 1

Ваш вопрос, похоже, не имеет никакого отношения к javascript или xml, по сути, а скорее к DocProject, который вы можете добавить в свои теги.

Answer 2

Несколько моментов, которые могут помочь вам понять, что происходит:

в XML-файлы Doc построены из комментариев на скомпилированный исходный код. Javascript не скомпилирован.

Единственная поддержка, которую Visual Studio имеет для XML-документов в JS, находится в окне редактора JS-кода для выполнения intellisense и завершения кода. Вот и все.

AjaxDoc - довольно сложный зверь, который работает только на JS, который построен с использованием MsAjax и использует систему набора текста.

AjaxDoc не может создавать XML-файлы для POJO (JavaScript Plain Ole»)

Я бы не задерживаю дыхание какого-либо ответа от Бертран.

В настоящее время я работаю над механизмом документации POJO, но моя работа занята. Вы можете увидеть прототип прототипа по требованию в браузере в каталоге/docs: this download

Извините, новости не лучше.