Tài liệu tham chiếu Java API Phần 3: Cấu trúc tham chiếu Eclipse Javadoc API được tạo ra thông qua việc chạy Java pps

Tài liệu tham chiếu Java API Phần 3: Cấu trúc tham chiếu Eclipse Javadoc API được tạo ra thông qua việc chạy JavaTOC doclet và ANT Mariana Alupului, Phát triển Thông tin, Rational software, IBM Tóm tắt: Bài viết này bàn thêm về JavaTOC doclet, cách sử dụng và mở rộng nó. Các cách tiếp cận được mô tả là giải pháp chuẩn Javadoc và sử dụng công cụ để tạo ra hệ trợ giúp trình bổ sung Eclipse. Tôi sẽ chạy JavaTOC doclet trong Eclipse thông qua thủ thuật Custom doclet, và thứ hai thông qua hệ thống xây dựng Ant. Công cụ JavaTOC tạo ra định hướng XML mục lục cho tài liệu tham chiếu Java API. Ôn tập nhanh Trong phần 1 của loạt bài này, Tài liệu tham chiếu Java API được tổ chức trong trợ giúp Eclipse như thế nào bài viết mô tả các cách tiếp cận khác nhau để tạo ra tài liệu tham chiếu giao diện lập trình ứng dụng (API) Java dễ sử dụng và có thể tìm kiếm được. Các cách tiếp cận được mô tả trong bài viết là giải pháp chuẩn Javadoc và sử dụng JavaTOC doclet tôi đã phát triển để tạo ra hệ trợ giúp trình bổ sung Eclipse. Trong phần 2 của loạt bài này, Sử dụng JavaTOC doclet để tạo cấu trúc tham chiếu Eclipse Javadoc API bài viết trình bày về JavaTOC doclet (bao gồm cả việc tải dữ liệu về) và cách dùng Command Prompt (giao diện dòng lệnh) để sử dụng JavaTOC doclet. Bài viết mô tả cách JavaTOC doclet tạo ra định hướng mục lục XML và khả năng tìm kiếm nâng cao cho tài liệu tham chiếu Javadoc API. Học cách yêu cầu lập trình viên trợ giúp mà không quan tâm đến việc các kỹ năng kĩ thuật của bạn giỏi đến mức nào. Ở đây có các chủ đề đã được các lập trình viên đúc rút ra, các chủ đề này đáng để giải thích và cân nhắc thêm, đây là các chủ đề không được người dùng yêu cầu và sử dụng. Sử dụng JavaTOC doclet để sinh trình bổ sung Eclipse (tài liệu tham chiếu Javadoc API) Hệ thống trợ giúp nền Eclipse cho phép bạn sử dụng điểm mở rộng org.eclipse.help.contributions để đóng góp trình bổ sung của mình vào trợ giúp trực tuyến. Bạn có thể đóng góp trợ giúp trực tuyến như là một phần của trình bổ sung mã của bạn hoặc cũng có thể cung cấp nó một cách độc lập trong trình bổ sung tài liệu của chính nó. Việc có trình bổ sung tài liệu của riêng bạn đem lại lợi ích trong việc làm việc với bản sao của mã nguồn và quá trình sinh tham chiếu độc lập với quá trình phát triển. Có thể có lợi khi cân nhắc đến cách tiếp cận này trong các tình huống như vậy, khi mà đội phát triển khác với đội làm tài liệu hoặc khi bạn muốn giảm độ phụ thuộc giữa nguồn tài liệu và mã nguồn. Điểm mở rộng org.eclipse.help.contributions cung cấp bốn phần tử, qua các phần tử này bạn có thể đóng góp các trợ giúp của mình: tập thông tin các chủ đề (sách), các hành động xem thông tin (lưới). Các đóng góp tập thông tin hoặc hành động chỉ ra một tệp .xml liên kết, tệp này chứa các chi tiết của việc đóng góp. Thiết kế các ràng buộc Cho dù bạn là một thư ký kỹ thuật có kỹ năng hay là một lập trình viên thì bạn đều muốn cung cấp cho người dùng các tham chiếu Java API đã được tạo tài liệu đầy đủ, dễ dàng tìm kiếm và duyệt. Bạn có thể chạy JavaTOC doclet để tạo ra các tệp định hướng XML mục lục và Javadoc, hoặc chạy công cụ để tạo ra các tệp định hướng XML mục lục và dùng Javadoc đã được lập trình viên tạo ra. Bài viết này trình bày giải pháp sử dụng chuẩn Javadoc Generation wizard để tạo ra Javadoc cho tài liệu tham chiếu Java API và JavaTOC doclet cho các tệp định hướng XML mục lục trong môi trường phát triển Eclipse. Bài viết này trình bày cách chạy JavaTOC doclet trong Eclipse thông qua thủ thuật Custom doclet, và thứ hai thông qua hệ thống xây dựng Ant. Nếu bạn chưa từng làm việc với Ant, hãy xem ở trang Web Jakarta, hoặc "Open Source Java: Ant" (Mã nguồn mở Java: Ant). Luồng công việc Thêm các công cụ tạo trình bổ sung JavaTOC (JavaAPITools) vào không gian làm việc của bạn:  Hãy tìm thư mục không gian làm việc mà phiên bản Eclipse của bạn sử dụng. Thông thường thì thư mục này được đặt trong thư mục mà trong đó Eclipse đã được cài đặt trong một thư mục con có tên gọi là "workspace". Nếu bạn đang sử dụng đường dẫn tắt hoặc kịch bản để gọi Eclipse, thì nó sẽ ở trong thư mục làm việc hiện tại mà đường dẫn tắt hay kịch bản của thư mục đó ở trong một thư mục con có tên gọi là "workspace".  Tải về và giải nén gói đó (JavaAPITools) vào không gian làm việc của bạn. Việc này sẽ tạo ra dự án "JavaAPITools".  Nạp dự án "JavaAPITools" và dự án Java mà bạn muốn làm việc với vào không gian làm việc Eclipse của bạn. Sử dụng thủ thuật nạp vào (Import Wizard) để nạp một dự án Java đã có sẵn vào không gian làm việc. Với ví dụ ở đây, tôi đã tạo ra một dự án Java mới "org.dita.dost" và thêm vào mã nguồn (thư mục src) từ mã nguồn DITA Open Toolkit , mã nguồn này biến đổi nội dung DITA (các ánh xạ và chủ đề) thành các định dạng có thể phát được. Bạn có thể tải trình bổ sung này về từ các nguồn tải về. Tạo tài liệu Javadoc bằng cách sử dụng thủ thuật tạo Eclipse Javadoc (Doclet chuẩn) Các bước tiếp theo hướng dẫn bạn cách sử dụng Javadoc Doclet chuẩn để tạo ra Javadoc trong môi trường phát triển Eclipse:  Trong Eclipse, ở khung ở bên trái, chọn trình bổ sung mã nguồn mà ta cần tạo Javadoc cho nó.  Nhấn chuột phải vào trình bổ sung đã được chọn và chọn Export từ danh sách thả xuống. Cửa sổ Export mở ra.  Chọn Javadoc và nhấn Next. Cửa sổ Generate Javadoc mở ra.  Trong cửa sổ Generate Javadoc chọn các gói mà bạn muốn xuất sang tệp JAR. Danh sách này được khởi tạo bằng việc chọn workbench. Mỗi lần chỉ được chọn một dự án bởi vì khi chạy công cụ Javadoc, mỗi lần chỉ được sử dụng một đường dẫn lớp dự án. (Hình 1).  Chọn tính hiển thị các thành viên (thông thường Package và Public).  Chọn Sử dụng Doclet chuẩn để bắt đầu lệnh Javadoc với doclet chuẩn (ngầm định). o Destination: chọn đích mà doclet chuẩn sẽ viết tài liệu được sinh ra vào đó. Đích là một đối số riêng cho doclet và vì vậy nó không được kích hoạt khi sử dụng doclet tùy biến. Đích mà doclet chuẩn sẽ viết vào có thể ví dụ là "doc.dita.dost.doc\topics" (Hình 2) Hình 1. Thủ thuật sinh Javadoc (Doclet chuẩn) Hình 2. Đích Bảng các tùy chọn trợ giúp được cung cấp bởi thủ thuật sinh Javadoc: Tùy chọn Mô tả Tiêu đề tài liệu Chỉ ra một tiêu đề tài liệu. Generate use page (sinh ra trang sử dụng) Chọn tùy chọn này nếu bạn muốn tài liệu chứa một Use page (trang sử dụng). Generate hierarchy tree (sinh ra cây Chọn tùy chọn này nếu bạn muốn tài liệu chứa một Tree thứ bậc) page (trang cây). Generate navigator bar (sinh thanh định hướng) Chọn tùy chọn này nếu bạn muốn tài liệu chứa một thanh định hướng (phần đầu và phần cuối). Generate index (sinh chỉ mục) Chọn tùy chọn này nếu bạn muốn tài liệu chứa một trang chỉ số Generate index per letter (sinh chỉ mục cho mỗi kí tự) Tạo chỉ số cho mỗi kí tự. Tùy chọn này được kích hoạt khi "Generate Index" (sinh chỉ số) được chọn. @author Chọn tùy chọn này nếu bạn muốn thẻ @author được làm tài liệu. @version Chọn tùy chọn này nếu bạn muốn thẻ @version được làm tài liệu. @deprecated Chọn tùy chọn này nếu bạn muốn thẻ @deprecated được làm tài liệu, tham chiếu đến một mục lục, ví dụ như deprecated list (danh sách không tán thành) Lựa chọn tùy chọn này nếu bạn muốn tài liệu chứa một trang không tán thành. Tùy chọn này được kích hoạt khi tùy chọn @deprecated được chọn. Chọn các lớp tham chiếu mà Javadoc cần tạo liên kết tới Chỉ ra là Javadoc cần tạo liên kết tới tài liệu nào khác khi mà các kiểu khác được tham chiếu.  Chọn tất cả: Tạo liên kết tới tất cả các vùng tài liệu khác  Xóa tất cả: Không tạo liên kết tới các vùng tài liệu khác  Định cấu hình: Định cấu hình vùng Javadoc của JAR tham chiếu hoặc dự án Style sheet (trang kiểu) Chọn trang kiểu sẽ sử dụng  Nhấn Finish để tạo Javadoc, hoặc nhấn Next để chỉ ra thêm các tùy chọn sinh Javadoc. GHI CHÚ: Để biết thêm chi tiết hãy xem Javadoc generation — Eclipse Help Platform (Sinh Javadoc - Nền trợ giúp Eclipse) Thư mục đích của các tệp đầu ra  Doclet sinh ra các tệp HTML đầu ra cho tài liệu trình bổ sung tại "org.dita.dost\org.dita.dost.doc\topics\", bây giờ đây chính là thư mục tài liệu trình bổ sung của bạn. Tạo định hướng XML mục lục và các tệp trình bổ sung Javadoc thông qua việc sử dụng thủ thuật sinh Eclipse Javadoc và JavaTOC doclet (Doclet tùy biến) Các bước sau đây thể hiện cách sử dụng doclet tùy biến, JavaTOC doclet, kết hợp với Javadoc trong môi trường phát triển Eclipse:  Trong Eclipse, ở khung phía bên trái, chọn trình bổ sung mã nguồn mà cần sinh Javadoc cho nó.  Nhấn chuột phải tại trình bổ sung đã chọn, và chọn Export từ danh sách thả xuống. Cửa sổ Export sẽ mở ra.  Chọn Javadoc và nhấn Next. Cửa sổ Generate Javadoc sẽ mở ra.  Trong cửa sổ Generate Javadoc chọn các gói mà bạn muốn xuất sang tệp JAR. Danh sách này khởi tạo bằng việc chọn workbench. Mỗi lần chỉ có thể chọn một dự án bởi vì khi chạy công cụ Javadoc, mỗi lần chỉ có thể sử dụng một đường dẫn lớp dự án.  Chọn tính hiển thị của thành viên (thông thường Package và Public).  Chọn Use Custom Doclet (Sử dụng doclet tùy biến) và thêm các tên kiểu doclet đủ tiêu chuẩn vào tên Doclet: com.ibm.malup.doclet.config.DITADoclet , và đường dẫn lớp mà lớp doclet cần vào đường dẫn lớp Doclet: <eclipse_workspace>\JavaAPITools\bin\JavaTOC.jar GHI CHÚ: <eclipse_workspace> là đường dẫn tuyệt đối cho không gian làm việc Eclipse (C:\eclipse\workspace). o Destination: chọn đích mà doclet chuẩn sẽ viết tài liệu được sinh ra vào đó. Đích là một đối số riêng của doclet và vì vậy nó không được kích hoạt khi sử dụng doclet tùy biến. Đích mà doclet chuẩn sẽ viết vào có thể được ví dụ là "doc.dita.dost.doc\topics"  Nhấn Next. Hình 3. Thủ thuật sinh Javadoc (Doclet tùy biến) Hình 4. Đích Các tùy chọn Javadoc mở rộng  Với các tùy chọn Javadoc mở rộng (các tên đường dẫn với các khoảng cách trắng phải được đặt trong các dấu nháy); thêm nội dung từ ví dụ 1 (với ví dụ của chúng ta là trình bổ sung org.dita.dost). 1. -d <destination_directory> Chỉ ra thư mục đích cho tài liệu được sinh ra. Theo ngầm định thì nó là thư mục hiện tại (thư mục được thiết kế bởi tên đường dẫn "."). 2. -pluginid <plugin_id> Bao gồm chỉ số của trang chỉ số trình bổ sung Eclipse. 3. -doctitle <html_code> Bao gồm tiêu đề của trang tên trình bổ sung Eclipse. 4. —overview <file> Chỉ ra các chi tiết chỉ số phiên bản trình bổ sung. [...]... và tạo ra một mục vào trong tệp plugin.properties của biểu mẫu: Plugin.name = Online Help Sample Plugin Sử dụng JavaAPITools (build.xml & JavaTOC doclet) và ANT để tạo trình bổ sung tài liệu của bạn Mục đích chính của JavaAPITools là tạo ra trình bổ sung NEW DOCUMENTATION (Tài liệu mới) với Javadoc cho tài liệu tham chiếu API công khai và tất cả các tệp trình bổ sung Eclipse cần thiết để tích hợp tài. .. tài liệu tham chiếu Java API này với hệ trợ giúp Eclipse, ngoại trừ các tệp định hướng XML mục lục cho Javadoc Cài đặt các công cụ xây dựng trình bổ sung (buildAPITools) Gói JavaAPITools cung cấp kịch bản xây dựng Eclipse cho việc tạo các trình bổ sung tài liệu Eclipse Kịch bản cho phép bạn chuyển đổi các trình bổ sung dự án Java trong Eclipse và sử dụng thời gian chạy theo mục tiêu đặt ra của Eclipse. .. trình viên và chúng được chỉnh sửa bởi cả các lập trình viên và các thư ký kĩ thuật JavaTOC Doclet được trình bày trong tài liệu này có thể được sử dụng để tạo tài liệu trợ giúp dựa trên HTML và một lượng nhỏ các thành phần tài liệu bổ sung Thông qua việc sử dụng doclet này có thể dễ dàng tạo ra tài liệu nền Eclipse, tài ... dựng được thực hiện Việc này sẽ chỉ tạo một tệp XML mục lục chính (xxx.toc.xml) thay vì nhiều tệp Tạo tệp ANT build.xml Kịch bản build.xml định nghĩa tất cả các thông tin cần thiết để tạo ra Javadoc cho các trình bổ sung thành phần kết hợp và tạo ra tệp doc.zip hoặc sao chép các tệp đã được tạo ra vào gốc của trình bổ sung Để hoàn thành tài liệu về các nhiệm vụ sẽ được sử dụng trong tệp này hãy xem JavaAPITools/build.xml... trợ được cung cấp bởi thủ thuật sinh Javadoc nếu bạn muốn thêm vào các tùy chọn để chạy Javadoc chuẩn Ví dụ: Để thêm tên tác giả (@author ) vào tài liệu thì thêm author="true" End Phase I Standard Doclet - Start Phase II JavaTocDoclet... sung, tạo ra cấu hình chạy bằng cách chọn Run > Run Việc này sẽ khởi chạy trang cấu hình chạy o Nhấn cấu hình ứng dụng Eclipse, rồi đến nút New và đặt cho nó một cái tên bất kì để chỉ định nó là trình bổ sung JavaTOCdoclet Eclipse thử nghiệm Chúng ta sẽ gọi nó là Test Plugin Doc o Ở thẻ Main, trong trường vị trí, chọn một thư mục không gian làm việc Mọi thứ mà bạn làm trong khi sử dụng thời gian chạy. .. kiểm tra chúng Hoàn thành việc tạo ra Javadoc bằng cách tạo ra một kịch bản ANT trong trình bổ sung của bạn có tên gọi là build.xm Kịch bản ANT này yêu cầu các công cụ xây dựng build.xml JavaAPITools phải được đặt đâu đó trong hệ thống phát triển (không gian làm việc) của bạn Kịch bản đó cũng phải có thể xác định được cách trình bổ sung xxx.doc kết quả được đóng gói để triển khai  Tải gói đó về, tạo. .. khác nữa là đủ Xem tài liệu tham chiếu Java API của bạn Từ Eclipse Test Platform mới, chọn Help > Help Contents Bạn sẽ thu được cửa sổ trợ giúp, hình 9, với trình bổ sung của mình đã được thêm vào (tương tự như trong hình 2) Hình 9 Help — Eclipse SDK Đóng gói trình bổ sung Một khi bạn đã hoàn thành việc này thì tất cả những gì bạn còn phải làm là để đóng gói tất cả mọi thứ trong cấu trúc, bằng cách sử... trình bổ sung vào không gian làm việc 1 Hình 7 Nạp trình bổ sung vào không gian làm việc 2 Hình 8 Nạp trình bổ sung vào không gian làm việc 3 Kiểm tra trình bổ sung tham chiếu Java API  Thiết lập môi trường thời gian chạy (runtime) đích: o o Đặt Location là thư mục eclipse chính trong sản phẩm đã được cài đặt bên ngoài Một danh sách các trình bổ sung trong thư mục Eclipse xuất hiện (bước này sẽ cần... trong phần Builders chọn New Lunch Configuration và tạo ra một cấu hình xây dựng Ant mới  Trong hộp thoại cấu hình kết quả, đặt tên là một cái gì đó duy nhất (ví dụ Build Plugin Documentation) Trong thẻ Main của phần tải cấu hình, duyệt không gian làm việc và chọn tệp build.xml từ JavaAPITools) Thêm vào thư mục Base giá trị: ${project_loc} Sơ đồ sau đây, hình 5, thể hiện thẻ Main của hộp thoại cấu hình . Tài liệu tham chiếu Java API Phần 3: Cấu trúc tham chiếu Eclipse Javadoc API được tạo ra thông qua việc chạy JavaTOC doclet và ANT Mariana Alupului, Phát triển Thông tin, Rational. lục và dùng Javadoc đã được lập trình viên tạo ra. Bài viết này trình bày giải pháp sử dụng chuẩn Javadoc Generation wizard để tạo ra Javadoc cho tài liệu tham chiếu Java API và JavaTOC doclet. các tham chiếu Java API đã được tạo tài liệu đầy đủ, dễ dàng tìm kiếm và duyệt. Bạn có thể chạy JavaTOC doclet để tạo ra các tệp định hướng XML mục lục và Javadoc, hoặc chạy công cụ để tạo ra