2013-02-10 51 views
50

làm cách nào để tạo liên kết javadoc thành trường riêng tư?Làm thế nào để liên kết javadoc với trường riêng?

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

{@link Foo#getBar()} hoạt động.

{@link Foo#bar} thì không.

+6

Tại sao bạn muốn liên kết javadoc với người dùng cuối cùng sẽ không thể thấy? –

+0

Tôi thường chúng tôi @link cho việc tự động đổi tên javadocs nếu tôi đổi tên những gì được liên kết. Vì vậy, tôi nghĩ rằng nếu tôi đổi tên "thanh" đôi khi, javadoc sẽ tự động bù đắp cho phù hợp. – membersound

+4

@ X.L.Ant vì nó cũng tốt cho bạn, khi bạn nhìn vào năm sau trên lĩnh vực riêng tư đó, và không biết ý nghĩa của nó là gì. Đặc biệt là khi javadoc của getter công cộng cho rằng feiled chỉ chứa tự động tạo javadoc bình luận: "getter method()" – AlexWien

Trả lời

77

Cú pháp là tốt, cả hai công việc sau đây trong một lớp học (và không có lý do gì để liên kết đến một lĩnh vực tư nhân từ một lớp khác nhau):

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

Khi tạo javadoc, ví dụ, thông qua kiến, chỉ cần chỉ định rằng các trường riêng tư phải được bao gồm (quyền truy cập tối thiểu mặc định là "được bảo vệ", không phải là "riêng tư"):

<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> 
5

Tôi nghĩ rằng những gì bạn đang viết trong các bình luận là tốt, bạn chỉ cần nói với JavaDoc cũng bao gồm các trường riêng trong tài liệu. JavaDoc có một tùy chọn -private cho việc này. Kiểm tra this answer.

Các vấn đề liên quan