eclipse XML编辑器/ Java编辑器:javadoc和包,方法和文件的链接

时间:2019-03-20 10:05:31

标签: xml eclipse javadoc properties-file

我们应该如何在Javadoc中指定外部文件,还有没有办法在XML编辑器中显示/链接这些条目?

这是我到目前为止所拥有的:

  • Java:
    • 在包,类,方法的声明中(通过[鼠标悬停]显示了JavaDoc
    • 编辑器中的
    • 链接(通过[CTRL])指向所引用的类和方法
    • JavaDoc弹出编辑器中的
    • 可用链接,用于显示所引用的包,类,方法的Javadoc
    • 仅适用于带有@see的非Java文件的“外部”链接

possible Java-Doc in Java editor

  • XML
    • 仅通过类显示的一种JavaDoc(通过[鼠标悬停])
    • 在编辑器中(通过[CTRL]链接)用于类和全名(TestProperties.properties,TestXML.xml)指定的文件

possible "Java-Doc" in XML editor

TestClass.java:

package org.test;

/**
 * JavaDoc for TestClass, referencings some stuff:<br />
 * <ul>
 * <li>{@link org.test.TestClass#testMethod}</li>
 * <li>{@link org.test.TestClass}</li>
 * <li>{@link org.test}</li>
 * <li>{@link resources#TestXML}<br/>
 * --> every other way of writing leads to "cannot be resolved to a type"</li>
 * <li>{@link resources#TestProp}</li>
 * <li>{@link resources#TestNotThere}</li>
 * <li>direct link without annotation: <a href="../../resources/TestProp.properties">property again </a></li>
 * </ul>
 * @see <a href="../../resources/TestProp.properties">property link</a>
 */
public class TestClass {

  /** JavaDoc for testMethod */
  public void testMethod() {
    // some method implementation
  }
}

源文件夹中的示例布局:

org.test
->package-info.java
->TestClass.java
resources
->TestProp.properties
->TestXML.xml

TestXML.xml:

<?xml version="1.0" encoding="UTF-8"?>
<testroot>
  <testmethod name="org.test.TestClass#testMethod" />
  <testclass name="org.test.TestClass" />
  <testpackage name="org.test" />
  <testproperty name="resources#TestProp" />
  <testproperty name="TestProp" />
  <testproperty name="TestProp.properties" />
  <testxml name="resources#TestXML" />
  <testxml name="TestXML" />
  <testxml name="TestXML.xml" />
</testroot>

问题:

  • 是否有更好/正确的方法在JavaDoc中指定非Java文件?
  • 是否有更好/正确的方法在Eclipse中使用XML和/或其他XML编辑器来指定方法名称?

0 个答案:

没有答案