관리 메뉴

Joonas' Note

[Java/JavaDoc] @see, @inheritDoc 본문

개발/Java

[Java/JavaDoc] @see, @inheritDoc

joonas 2022. 4. 15. 00:41

    /* */ 주석을 이용해서 JavaDoc을 자동으로 만들 수 있는데, @Override 한 함수도 똑같이 적어주는 건 귀찮고 불필요한 일이다.

    그때마다 @see {#link ClassABC} 처럼 작성해서 오버라이드한 함수를 직접 링크했는데, 그럴 필요가 없었다.

    /**
     * 
     * @author Hari Krishna
     * 
     * @since 1.0
     */
    public class ABCOrg {
      /**
       * Print welcome message to employee.
       * 
       * @param empName
       *            Employee Name
       */
      public void welcomeEmployee(String empName) {
        System.out.println("Hello " + empName);
      }
    }
    
    public class XYZOrg extends ABCOrg {
      /**
       * {@inheritDoc}
       */
      @Override
      public void welcomeEmployee(String empName) {
        System.out.println("Hello " + empName);
      }
    }

    @inheritDoc 으로 함수 원형을 그대로 가져올 수 있었다.

    JavaDoc 결과

     

    출처: https://self-learning-java-tutorial.blogspot.com/2018/01/javadoc-inheritdoc-inherit-documentation.html

    반응형
    0 Comments
    댓글쓰기 폼