Eclipse JavaDoc LaTeX方程式

时间:2014-06-16 19:37:15

标签: java eclipse latex javadoc

我有代码,在JavaDoc注释中有很多方程式很常见。我目前正在使用MathML来显示这些方程式,因为它是我能够获得可以在Eclipse的悬停工具提示中显示的方程式的唯一方法。

我实际上并不关心创建的HTML。我只需要Eclipse徘徊就能正确显示方程式。

不幸的是,MathML 疯狂详细。一行简单 LaTeX成为50行MathML!它使我的源代码混乱,源代码中的JavaDoc注释无法读取(您 将鼠标悬停在该方法上以阅读注释)。

有没有人知道在Eclipse中使用LaTeX方程的方法会出现在这个悬停文本中?

编辑:像this这样的东西会更好,但这并不适用于Eclipse的徘徊。据推测,没有办法在这些中注入JavaScript。

2 个答案:

答案 0 :(得分:3)

建议1:使用MathJax

我使用MathJax在JavaDoc中编写LaTeX方程。你可能会在这里看到结果: http://finmath.net/java/finmath-lib/apidocs/net/finmath/montecarlo/interestrate/LIBORMarketModel.html

但是,MathJax依赖于JavaScript而Eclipse Hover不支持JavaScript。但是我必须说即使没有渲染器也可以读取MathJax LaTeX,所以对我来说可以在悬停文本中使用LaTeX代码。如果您在悬停文本中启用JavaScript,您会看到它 - 但这是一个不同的问题。

要启用MathJax,您只需在docket配置中包含一个标题,如

                <header>
                    <![CDATA[
                    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
                    </script>
                    ]]>
                </header>

建议2:在本地计算机上使用CLSI

如果您只为自己需要,可以运行CLSI(common-latex-service-interface)。然后,也许有可能只有一个带有乳胶代码的图像标签在其URL中返回一个图像)。我没有详细说明......(我个人更喜欢选项1,因为它也会在JavaDoc中生成LaTeX。

答案 1 :(得分:2)

您可以尝试LaTeXlet

看看:http://users.informatik.uni-halle.de/~grau/LaTeXlet/

LaTeXlet是一个允许在Javadoc注释中使用LaTeX的标记。

以下是一个例子:

http://users.informatik.uni-halle.de/~grau/LaTeXlet/doc/latexlet/BlockLaTeXlet.html

相关问题