Блог

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

Это то, что у меня есть на данный момент:

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

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

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?