eclipse XML editor / Java Editor: javadoc и ссылки для пакетов, методов и файлов - PullRequest
Новая
       32

eclipse XML editor / Java Editor: javadoc и ссылки для пакетов, методов и файлов

0 голосов
/ 20 марта 2019

Как нам указать внешние файлы в Javadoc, и есть ли способ показать / связать эти записи в XML-редакторе, тоже?

Это то, что у меня так далеко:

  • Java:
    • JavaDoc отображается (через [наведение мыши]) в объявлении пакета, класса, метода
    • ссылка (через [CTRL]) в редакторе для указанного класса и метода
    • используемая ссылка во всплывающем редакторе JavaDoc, чтобы показать Javadoc для указанного пакета, класса, метода
    • рабочая «внешняя» ссылка только для файла, не относящегося к Java, с @see

possible Java-Doc in Java editor

  • XML
    • своего рода JavaDoc, показанный (через [наведение мыши]) только дляссылка на класс
    • (через [CTRL]) в редакторе для класса и для файлов, указанных с полным именем (TestProperties.properties, TestXML.xml)

possible

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>

Вопросы:

  • Есть ли лучший / правильный способ указать не Java-файлы в JavaDoc?
  • Есть ли лучший / правильный способ указатьимена методов в XML и / или другой редактор XML для использования в Eclipse?
...