XML документация для контекстно-зависимой помощи - PullRequest
1 голос
/ 24 апреля 2010

В наши дни для этой цели был разработан ряд коммерческих инструментов и инструментов с открытым исходным кодом. Однако (к сожалению), ни один из них не отвечает моим требованиям по конкретной проблеме, с которой я имею дело. В настоящее время я работаю над проектом, который предоставляет различные классы и функции пользователю в качестве интерфейса сценариев. Пользователь может использовать объекты из пользовательского интерфейса сценариев и вызывать методы для решения некоторых конкретных проблем.

Проблема, с которой я сталкиваюсь, заключается в том, что пользователям моих классов нужна какая-то документация для эффективного написания своего сценария. Для решения этой проблемы я планирую использовать сгенерированный компилятором XML-файл для предоставления контекстно-зависимой справки, которая позволяет пользователям навести курсор мыши на любой из элементов управления и соответствующих методов из графического интерфейса и прочитать справочную документацию по классу / методу.

Мои вопросы:

  • Могу ли я получить пример исходного кода?

  • Может кто-нибудь посоветовать мне, как лучше всего подойти к этой проблеме?

1 Ответ

0 голосов
/ 13 мая 2010

Free Pascal имеет нечто подобное. Он имеет отдельный синтаксический анализатор, который генерирует тезисы XML отдельно, которые являются основой для инструмента документации (fpdoc)

Lazarus IDE может читать эти XML-файлы в фоновом режиме, что позволяет редактировать документацию во время редактирования. Конечно, он также может отображать уже введенную информацию. (хотя больше в вики-подобной косметике, не отображается)

...