XML XML-документация для комментариев

Question

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

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

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

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

Answer 1

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

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

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

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

AjaxDoc не может создавать xml-файлы для POJO (plain ole 'javascript)

Я бы не стал затаить дыхание на какой-либо ответ от Бетранда.

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

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

Answer 2

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