Làm cách nào để đính kèm javadoc hoặc nguồn vào bình trong thư mục libs?


254

Phiên bản mới của plugin ADT r17 cho tính năng được thêm vào Eclipse để tự động thiết lập các phụ thuộc JAR. Bất kỳ tệp .jar nào trong thư mục / libs đều được thêm vào cấu hình bản dựng ngay bây giờ. Thật không may, bộ chứa classpath Android Dependencies không thể sửa đổi.

Classpath không thể sửa đổi android classpath

Làm cách nào tôi có thể đính kèm javadoc và nguồn vào thư mục .jar (từ thư mục / libs) được chèn tự động?


Tôi không nghĩ câu hỏi của bạn đã được trả lời. Câu trả lời được chấp nhận của Mark đưa ra chính xác những gì bạn yêu cầu KHÔNG phải là giải pháp. Làm cách nào chúng tôi có thể đính kèm javadoc và nguồn thông qua các phần mềm tự động (không qua các lọ thủ công)?
pjv

2
Có một vấn đề đối với lỗi mã này.google.com/p/android/issues/detail ? id=27490#c21 . Nhận xét 21 nói rằng có thể đính kèm nguồn / javadoc trong ADT r20 với tệp java .properations tiêu chuẩn (foo.jar -> foo.jar.properies) cho phép bạn chỉnh sửa đường dẫn tương đối hoặc tuyệt đối vào thư mục nguồn (hoặc lưu trữ) và / hoặc đường dẫn tương đối hoặc tuyệt đối đến javadoc.
Sergii Pechenizkyi

Câu trả lời:


401

Cách tốt nhất để trả lời câu hỏi của bạn là tóm tắt các câu trả lời từ Xavier , plastiv , VinceFRChristopher .

Hướng dẫn từng bước một

Để liên kết các nguồn và javadoc với một thư viện .jar được Eclipse tự động liên kết, bạn phải làm như sau:

  1. Đặt tệp .jar của thư viện trong thư mục libs và các tệp .jar và doc .jar liên quan trong các thư mục con riêng biệt như libs / srclibs / docs . Bạn có thể sử dụng tên khác với srcdocs nếu muốn, nhưng điều quan trọng là các tệp .jar không trực tiếp trong thư mục libs .
  2. Tạo một .propertiestệp trong thư mục libs với tên chính xác của thư viện thực tế .jar (xem ví dụ). Hãy chắc chắn rằng bạn giữ phần .jar .
  3. Chỉ định các đường dẫn tương đối đến các nguồn và javadoc .jar trong .propertiestệp.
  4. Đóng và mở lại dự án Eclipse! Tùy chọn, làm mới dự án bằng cách nhấn F5.
  5. Chọn một đối tượng của thư viện được liên kết trong mã nguồn.
  6. Mở khung nhìn Javadoc trong Eclipse để kiểm tra tài liệu (xem ảnh chụp màn hình).
  7. Mở khai báo mã nguồn (phím tắt mặc định F3:) của đối tượng được chọn.


Thí dụ

Ví dụ sử dụng thư viện Gson .

Cấu trúc thư mục của thư mục libs:

libs
├── docs
   └── gson-2.2.2-javadoc.jar
├── gson-2.2.2.jar
├── gson-2.2.2.jar.properties
└── src
    └── gson-2.2.2-sources.jar

Nội dung của gson-2.2.2.jar.properies

src=src/gson-2.2.2-sources.jar
doc=docs/gson-2.2.2-javadoc.jar


Thông tin thêm

Tất nhiên bạn có thể di chuyển javadoc và nguồn .jar vào các thư mục khác và chỉ định các đường dẫn tương đối. Tùy bạn. Đặt nguồn và javadoc lọ trực tiếp vào lib thư mục là có thể nhưng không được khuyến khích , vì điều đó gây ra tài liệu và mã nguồn được bao gồm trong ứng dụng của bạn .


Ảnh chụp màn hình của bảng JavaDoc của Eclipse:

Khung nhìn JavaDoc trong Eclipse

Ảnh chụp màn hình của một dự án Eclipse sử dụng Gson với Android 4.2.2.:

Ảnh chụp màn hình dự án thử nghiệm Eclipse


Tham khảo javadocs đã giải nén

Trong trường hợp bạn muốn tham khảo javadocs không được cung cấp dưới dạng đóng gói .jarmà chỉ đơn giản là các tệp và thư mục theo yêu cầu của nhà phát triển Android trong các nhận xét, hãy làm như sau:

  1. Đặt thư viện .jartrong libs/thư mục
  2. Tạo một yourlibraryname.jar.propertiestệp ( đừng quên.jar ) với nội dung sau:

     doc=docs
  3. Thêm các thư mục javadocs vào libs/thư mục.

Bạn nên đến với cấu trúc thư mục sau:

├── docs
   ├── allclasses-frame.html
   ├── allclasses-noframe.html
   ├── com
      └── google
          └── ads
              ├── Ad.html
                 ....
              └── package-tree.html
      ...
   └── stylesheet.css
├── GoogleAdMobAdsSdk-6.4.1.jar
└── GoogleAdMobAdsSdk-6.4.1.jar.properties

Đừng quên đóng và mở lại dự án Eclipse như đã đề cập ở trên! Dưới đây là ảnh chụp màn hình của một dự án ví dụ hoạt động tham khảo thư viện GoogleAdMobAds Android .

Thư viện Android của GoogleAdMobAds Dự án Eclipse


7
Ahhh, đó là việc đóng và mở lại dự án Eclipse cần thiết cho tôi. (Tôi đã làm mới và dọn dẹp nhiều lần mà không gặp may mắn trước đó.)
Steve Haley

4
Cảm ơn @JJD đã làm việc tuyệt vời. Tôi chỉ phải khởi động lại Eclipse trước khi nó bắt đầu hoạt động.
javajavajavajavajava

26
Lưu ý: Bạn thực sự nên đặt Javadoc và JAR nguồn vào thư mục con, ví dụ: "./libs/docs", nếu không, các JAR này sẽ được gói vào APK của bạn! Ngoài ra, bạn sẽ không thể bao gồm Javadoc cho nhiều thư viện, vì việc xây dựng APK sẽ thất bại khi tìm thấy các tệp HTML trùng lặp.
Christopher Orr

5
Có thể tham khảo một javadoc từ xa từ tệp .properations không? Giống như vậy: doc = Community.versant.com/documentation/reference/db4o-8.0/java/api
Matthias

9
Rõ ràng điều này không hoạt động nếu bạn chỉ liên kết Javadoc chứ không phải mã nguồn, tôi đã phải trích xuất jar Javadoc với 7zip vào một thư mục trong Tài liệu của tôi, sau đó có tệp thuộc tính trỏ đến thư mục có chỉ mục Javadoc .html trực tiếp như vậy doc = C: \\ Users \\ johny \\ workspacenewfb \\ robotium-solo-4.0-javadoc
mbwasi

25

Trên cửa sổ, bạn phải thoát dấu gạch chéo ngược để tham chiếu đến đường dẫn doc và src trong tệp thuộc tính. Ví dụ, đối với android-support-v4.jar, nội dung tệp thuộc tính giống như:

doc=C:\\Program Files (x86)\\Android\\android-sdk\\extras\\android\\support\\v4\\docs
src=C:\\Program Files (x86)\\Android\\android-sdk\\extras\\android\\support\\v4\\src

1
wow câu trả lời của bạn đã giải quyết vấn đề của tôi, tôi đặt một \ nhưng chúng ta phải đặt \. cảm ơn rất nhiều
Arash

17

Câu trả lời đến từ http://code.google.com.vn/p/android/issues/detail?id=27490#c21

Trong thư mục libs của bạn, bạn phải có:

doc(folder)
    foo_doc(folder)
        index.html
        ...
        ...
foo.jar
foo.jar.properties

Và trong của bạn foo.jar.properties, chỉ cần đặtdoc=./doc/foo_doc

Có thể bạn sẽ phải làm mới dự án của mình, để làm sạch nó, đóng nó và mở lại nó.

Nó làm việc cho tôi!


Nếu bạn có tài liệu trong tệp zip, đây là cách để đi, cảm ơn rất nhiều !! giơ ngón tay cái lên
Akhil Jain

10

Tôi đã thử tất cả những điều trên và không ai trong số họ làm việc cho tôi. Tôi đã tìm ra một phương pháp sẽ luôn luôn làm việc. Về cơ bản, thủ phạm là cách mà ADT xử lý thư mục "libs" nên tôi đã bỏ sử dụng thư mục "libs". Thay vào đó tôi tạo một thư mục "thư viện" và sử dụng nó.

Bạn có thể thực hiện các thao tác sau và nó sẽ luôn hoạt động - ngay cả khi ADT sẽ thay đổi cách thay đổi cách xử lý thư mục "libs" trong tương lai:

  1. Tạo một thư mục "thư viện".
  2. Tạo một thư mục con bên dưới nó cho mỗi thư viện.
  3. Đặt tất cả các tệp cho mỗi thư viện vào thư mục thích hợp (tệp jar java, tệp jar nguồn, tệp jar javadoc, v.v.).
  4. Thêm tệp jar java cho mỗi dự án trong tab "Thư viện" cho Đường dẫn xây dựng Java bằng cách nhấp vào Add Jars...nút để thêm tệp jar từ thư mục con thư viện trong thư mục "thư viện".
  5. Đính kèm nguồn / javadocs cho mỗi dự án bằng cách mở dự án trong tab "Thư viện", chọn mục mong muốn và nhấp vào Edit...nút để thêm nguồn / javadocs từ thư mục con thư viện trong thư mục "thư viện".
  6. Kiểm tra hộp kiểm cho từng dự án trong tab "Đặt hàng và xuất" cho Đường dẫn xây dựng Java.
  7. Sau khi xác minh rằng tất cả các thư viện đã được di chuyển, hãy xóa thư mục "libs".

Bằng cách làm theo quy trình trên, dự án của bạn sẽ có các thư mục trông như thế này:

nhập mô tả hình ảnh ở đây

Đường dẫn xây dựng Java của bạn sẽ trông giống như thế này:

nhập mô tả hình ảnh ở đây

Trong thứ tự và xuất các thư viện được đánh dấu:

nhập mô tả hình ảnh ở đây


5

Hiện tại, hãy chuyển thư viện mà bạn muốn Javadoc sang lib. Họ thêm thư viện đó vào Build Pathvà thêm Javadoc.

Kiểm tra bình luận này trong các vấn đề Android.


Đừng quên (như tôi đã làm) để kiểm tra đơn hàng và đặt thư viện để xuất trong Build Path.
Carlos Sobrinho

4

Trên ADT 22, tôi không thể truy cập Javadoc cho cả commons-io-2.4.jar và android-support-v4.jar

Đây là cách tôi sửa nó:

  1. Điều kiện tiên quyết: cả hai thư viện được liệt kê trong "Thư viện tham chiếu".

  2. Nhấp chuột phải vào commons-io-2.4.jar và chọn Thuộc tính. Cửa sổ này xuất hiện:

nhập mô tả hình ảnh ở đây

commons-io-2.4.jar được gói cùng với commons-io-2.4-javadoc.jar, vì vậy tôi đã chỉ định Javadoc trong lưu trữ đường dẫn tệp bên ngoài.

Tôi đã làm điều tương tự cho thư viện hỗ trợ: nhấp chuột phải vào android-support-v4.jar và chọn Thuộc tính. Màn hình này xuất hiện:

nhập mô tả hình ảnh ở đây

Lần này tôi chỉ định đường dẫn đến thư mục nguồn.


Đây là phương pháp dễ nhất và trực tiếp nhất để đính kèm javadoc và / hoặc src vào thư viện. Cảm ơn! Là một ghi chú được thêm vào, cả javadoc và src đều không bắt buộc phải có trong Thư viện tham chiếu.
bạc

3

Tham chiếu thư viện cho commons-io-2.0.1.jar đã bị hỏng khi tôi nâng cấp lên SDK Tools và sửa đổi ADT 17.

Để giải quyết vấn đề tôi đã sử dụng Project -> Properties -> Java Build Path và tôi đã chọn tab Thư viện. Tôi đã xóa mọi tham chiếu đến commons-io-2.0.1.jar và sau đó sử dụng Add Jar để thêm lại commons-io-2.0.1.jar vào dự án. Sau đó, tôi nhấp vào mũi tên '>' bên cạnh tên thư viện để mở rộng tham chiếu thư viện và tôi đã sử dụng các nút chỉnh sửa để đặt tệp đính kèm Nguồn và vị trí Javadoc.

Xin lỗi tôi không thể đăng một hình ảnh vì tôi không có đủ đại diện (xin vui lòng ...).


Không làm việc cho tôi. Nơi nào bạn có tập tin jar được giữ trong dự án của bạn? Tôi có của tôi trong thư mục libs.
Daniel Ryan

Cuối cùng ai đó đã đưa ra một hướng dẫn thực sự làm việc! Cảm ơn bạn rất nhiều. Không có phương pháp nào được đề cập bao gồm tệp ".properations" đã làm tốt cho tôi, nhưng việc thêm thư viện này dưới dạng JAR bên ngoài trong màn hình hộp thoại đã thực hiện công việc.
AlxDroidDev

1

Có vẻ là một mục tiêu di động, nhưng sau khi đã thu thập các mẩu và mảnh từ nhiều nơi (bao gồm cả câu trả lời cho chính câu hỏi này đã giúp nhưng không thể mô tả tất cả các chi tiết cần thiết, hoặc có thể hệ thống đã thay đổi một chút trong lúc này), điều này dường như là giải pháp, ít nhất là đến bây giờ (28 tháng 8 năm 2013).

  • Mở một thư mục cho javadocs của bạn ở đâu đó không nằm trong dự án của bạn.
  • Đặt javadocs của bạn ở đó được giải nén, mỗi tệp vào thư mục riêng của nó.
  • Trong libthư mục của bạn , thêm một xxx.jar.propertiestệp cho mỗi lib bạn muốn liên kết với một javadoc.
  • Trong tệp thuộc tính đó, hãy tham khảo thư mục bạn đã giải nén javadoc thích hợp vào (trên Windows, thoát dấu gạch chéo ngược):

doc=d:\\Android\\javadoc\\libGoogleAnalyticsServices

  • Đóng và mở lại dự án của bạn trong Eclipse (làm mới là không đủ). Bây giờ bạn sẽ thấy các chú giải công cụ khi bạn di chuột qua các lớp thích hợp.

Không quan sát bất kỳ bước nào trong số các bước này (không giải nén javadoc, tham chiếu tệp thay vì thư mục, v.v.) dường như phá vỡ nó.


1

Tôi biết câu hỏi này khá cũ, nhưng khi tôi gặp phải vấn đề tương tự ngày hôm qua và giải pháp được đăng ở trên quá khó chịu đối với tôi, tôi phát hiện ra rằng người ta có thể dễ dàng thêm định nghĩa đường dẫn nguồn vào tệp. Classpath của dự án. Eclipse sau đó sẽ điều chỉnh nó và bạn có thể duyệt qua nguồn.

mục nhập đường dẫn trước:

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]"/>

Sau khi thêm đường dẫn đến nguồn

<classpathentry kind="lib" path="[PATH_TO_MY_JAR]" sourcepath="[PATH_TO_MY_SOURCE_JAR]"/>

Hi vọng điêu nay co ich


0

chỉ cần cập nhật plugin ADT. Điều đó làm việc cho tôi !!

  1. Bắt đầu Eclipse, sau đó chọn Trợ giúp> Cài đặt phần mềm mới.
  2. Nhấp vào Thêm, ở góc trên bên phải.
  3. Trong hộp thoại Thêm Kho lưu trữ xuất hiện, nhập "Trình cắm ADT" cho Tên và URL sau cho Vị trí: https://dl-ssl.google.com/android/eclipse/ Lưu ý: Trang web cập nhật Công cụ dành cho nhà phát triển Android yêu cầu một kết nối an toàn. Đảm bảo URL trang web cập nhật bạn nhập bắt đầu bằng HTTPS.
  4. Nhấn OK. Trong hộp thoại Phần mềm khả dụng, chọn hộp kiểm bên cạnh Công cụ dành cho nhà phát triển và nhấp vào Tiếp theo.
  5. Trong cửa sổ tiếp theo, bạn sẽ thấy một danh sách các công cụ sẽ được tải xuống. Nhấn tiếp.
  6. Đọc và chấp nhận các thỏa thuận cấp phép, sau đó nhấp vào Kết thúc.
  7. Nếu bạn nhận được cảnh báo bảo mật nói rằng tính xác thực hoặc tính hợp lệ của phần mềm không thể được thiết lập, nhấp OK.
  8. Khi quá trình cài đặt hoàn tất, hãy khởi động lại Eclipse

Mong rằng sẽ giúp!


0

Đối với bất kỳ tệp đã cho nào, nếu bạn muốn thấy trợ giúp Javadoc trên tooltip trong khi mã hóa, hãy làm như sau: Nhấp chuột phải vào dự án của bạn> Thuộc tính> Đường dẫn xây dựng Java> Tab thư viện. Nhấp vào mũi tên bên cạnh bình của bạn để mở rộng.

Tệp đính kèm nguồn phải trỏ đến vị trí của jar thực tế (có thể ngay trong thư mục java của bạn).

Vị trí Javadoc : Bạn có hai lựa chọn ở đây: URL và lưu trữ. Nếu javadocs của bạn cho tệp này ở dạng thư mục chứa tệp index.html ở cấp độ đầu tiên, hãy chọn 'URL Javadoc' và trỏ đến thư mục đó. Nếu javadocs của bạn nằm trong một nhóm, hãy chọn 'Javadoc trong kho lưu trữ' và trỏ đến tệp. Đừng quên khởi động lại không gian làm việc / đóng và mở lại dự án của bạn để cập nhật chú giải công cụ với thông tin Javadoc.

Tôi hy vọng điều này sẽ giúp đưa ra một câu trả lời đơn giản cho những gì tôi tin là một nhiệm vụ rất đơn giản.


0

Giải pháp của tôi:

Tải xuống một plugin nhật thực có tên: "Tính năng trình thu thập nguồn Java".

Sau đó, chọn một jar và đính kèm mã nguồn bằng cách sử dụng plugin này. Nhấp vào tệp jar để chọn nó, mông phải trên chuột và sau đó chọn "đính kèm nguồn java".

Khi bạn có mã nguồn, bạn sẽ tự động javadoc.

Bây giờ bạn có thể sử dụng F2 trên các lớp để xem javadoc được liên kết.

Thưởng thức

Khi sử dụng trang web của chúng tôi, bạn xác nhận rằng bạn đã đọc và hiểu Chính sách cookieChính sách bảo mật của chúng tôi.
Licensed under cc by-sa 3.0 with attribution required.