ProgramingTip

javadoc을 private 필드에 연결하는 방법은 무엇입니까?

bestdevel 2020. 10. 19. 12:21
반응형

javadoc을 private 필드에 연결하는 방법은 무엇입니까?


이 질문에 이미 답변이 있습니다.

비공개 필드에 대한 javadoc 링크를 어떻게 만들 수 있습니까?

class Foo {
  private String bar;
  public String getBar() { return bar; }
}

{@link Foo#getBar()} 공장.

{@link Foo#bar} 하지 않습니다.


구문은 괜찮습니다. 다음 두 가지 모두 클래스 내에서 작동합니다 (다른 클래스의 개인 필드에있는 이유가 없습니다).

public class Demo {
  private int num = 0;
  /**
  * Access field {@link Demo#num} / {@link #num}  ...
  */
  private void foo() { ... }
...

예를 들어 ant를 통해 javadoc을 생성 할 때 private 필드가 포함되고 기본 지정하기 만하면됩니다 (최소 액세스는 "private"가 아니라 "protected"입니다).

<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에는이를위한 -private 옵션이 있습니다. 이 대답을 확인하십시오 .

참고 URL : https://stackoverflow.com/questions/14796921/how-to-link-javadoc-to-private-field

반응형