带方程的 Javadoc?
我只熟悉简单的 javadoc 生成器,但是我想在我的 javadoc 中包含一些数学方程(而不是不断引用另一个文档)。
是否有一个方便的选项可以执行诸如包含/正确渲染 LaTeX(最优选 - 然后我可以直接剪切粘贴)或 MathML 标签之类的操作?
I'm only familiar with the no-frills javadoc generator, however I'd like to include some mathematical equations in my javadoc (rather than constantly referencing another document).
Is there a convenient option to do something like include/properly render LaTeX (most preferred - then I could just cut-n-paste) or MathML tags?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(3)
查看 Doxygen。
它速度极快、免费,并且支持嵌入式 LaTeX。
Check out Doxygen.
It's blazing fast, free, and supports embedded LaTeX.
也许类似于 MathJax 或 jsMath 可能是您的解决方案。它们都是 JavaScript 库,因此您必须找到一种方法将它们添加到您的 javadocs 页面中。
Maybe something like MathJax or jsMath could be your solution. They're both JavaScript libraries, so you'll have to find a way to add them into your javadocs pages.
虽然我个人没有这样做,但有一些方法可以使用 Doclet 或 Taglet API 创建您自己的 Doclet 或 Taglet。其中一些已经根据快速搜索完成,提供了一个这样的示例 http://www.ohloh。 net/p/latextaglet
如果您足够大胆,latextaglet 项目是开源的,因此您可以进一步调整它以满足您的需求。
While I haven't done it personally, there are ways to create your own using the Doclet or Taglet API to create your own Doclet or Taglet. Several of these have already been done according to a quick search providing one such example http://www.ohloh.net/p/latextaglet
If you're feeling daring enough the latextaglet project is open source, so you might be able to further adapt it to your needs.