Как связать javadoc с частным полем? [дубликат]
этот вопрос уже есть ответ здесь:
- Java Javadoc include Private 2 ответы
как я могу сделать ссылку javadoc на частное поле?
class Foo {
private String bar;
public String getBar() { return bar; }
}
{@link Foo#getBar()}
строительство.
{@link Foo#bar}
нет.
2 ответа:
синтаксис в порядке, как следующая работа в классе (и нет причин ссылаться на частное поле из другого класса):
public class Demo { private int num = 0; /** * Access field {@link Demo#num} / {@link #num} ... */ private void foo() { ... } ...
при создании javadoc, например, через ant, просто укажите, что частные поля должны быть включены (минимальный доступ по умолчанию "защищен", а не"частный"):
<target name="javadoc" depends="compile" description="gen javadoc"> <javadoc destdir="build/docs" author="true" version="true" use="true" access="private" windowtitle="Demo API"> <fileset dir="src/main" defaultexcludes="yes"> <include name="com/**"/> </fileset> <doctitle><![CDATA[<h1>Test</h1>]]></doctitle> <link offline="true" href="http://download.oracle.com/javase/6/docs/api/" packagelistLoc="doc"/> </javadoc> </target>
Я думаю, что то, что вы пишете в комментариях, прекрасно, вам просто нужно сказать JavaDoc, чтобы также включить частные поля в документацию. У JavaDoc есть опция-частная для этого. Проверьте ответ.