用于上下文相关帮助的 XML 文档
如今，已经为此目的开发了许多商业和开源工具。然而（不幸的是），它们都不能满足我正在处理的特定问题的要求。目前，我正在开发一个项目，该项目将不同的类和函数作为脚本接口向用户公开。用户可以使用自定义脚本接口中的对象并调用方法来解决一些特定问题。
我面临的问题是我的类的用户需要某种文档才能有效地编写他们的脚本。为了解决这个问题，我计划使用编译器生成的 XML 文件来提供上下文相关帮助，它允许用户将鼠标悬停在 GUI 中的任何控件和相应方法上，并阅读类/方法的参考文档。
我的问题是：
我可以获得示例源代码吗？
任何人都可以告诉我如何最好地解决这个问题吗？
These days a number of commercial and open source tools have been developed for this purpose. However (unfortunately), none of them meet my requirement for a specific problem I am dealing with. Currently, I am working on a project that exposes different classes and functions to a user as a scripting interface. The user can use the objects from the custom scripting interface and call methods to solve some specific problems.
The problem I am facing is that users of my classes need some sort of documentation in order to write their script efficiently. To address this problem I am planing to use the compiler generated XML file to provide context sensitive help, which allows users to mouse over on any of the controls and corresponding methods from the GUI and read the reference documentation of the class/method.
My questions are:
Can I get the sample source code?
Can any one advise me how best to approach this problem?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
Free Pascal 有类似的东西。它有一个单独的解析器，可以单独生成 XML 摘要，这是文档工具 (fpdoc) 的基础。Lazarus
IDE 可以在后台读取这些 XML 文件，允许在编辑时编辑文档。当然它也可以显示已经输入的信息。 （虽然更多的是类似维基的妆容，但没有渲染）
Free Pascal has something similar. It has a separate parser that generates XML abstracts separately, which are the basis for the documentation tool (fpdoc)
The Lazarus IDE can read these XML files in the background, allowing to edit the documentation while editing. It of course can also display already entered information. (though more in a wiki-like makeup, not rendered)