Viết javadoc phù hợp với @see?

Question

Làm cách nào để sử dụng chính xác javadoc @see?

Ý định của tôi là có một lớp trừu tượng với các phương pháp trừu tượng. Những phương thức này có nhận xét javadoc. Bây giờ nếu tôi mở rộng lớp trừu tượng, tôi ghi đè lên các phương thức và muốn sử dụng @see.

Nhưng đối với tất cả các thông số, ví dụ: return liên kết @see dường như không hoạt động. Eclipse vẫn phàn nàn rằng expected @return tag.

Vậy làm cách nào tôi có thể sử dụng tính năng này?

public abstract class MyBase { 
    protected abstract void myFunc(); 
} 

class MyImpl extends MyBase { 

    /** 
    * @see MyBase#myFunc() 
    */ 
    @Override 
    protected void myFunc() { .. } 
} 

Answer 1

Với mục đích bao gồm tài liệu từ siêu lớp, bạn nên sử dụng {@inheritDoc} không @see.

Sau đó, bạn sẽ nhận được tài liệu của siêu lớp. Bạn có thể thêm vào nó và bạn có thể ghi đè các nội dung như @param và @return nếu cần.

public abstract class MyBase { 
    /** 
    * @param id The id that will be used for... 
    * @param good ignored by most implementations 
    * @return The string for id 
    */ 
    protected abstract String myFunc(Long id, boolean good); 
} 

class MyImpl extends MyBase { 

    /** 
    * {@inheritDoc} 
    * @param good is used differently by this implementation 
    */ 
    @Override 
    protected String myFunc(Long id, boolean good) { .. } 
}