Tài liệu tham chiếu Java API Phần 2 pptx

Tài liệu tham chiếu Java API Phần 2: Sử dụng JavaTOC doclet để sinh cấu trúc tham chiếu Eclipse Javadoc API Mariana Alupului, Phát triển Thông tin, Rational software, IBM Tóm tắt: Bài viết này (là phần 2 của loạt 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. Ô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 , tôi đã giới thiệu một cách tiếp cận khác để 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. Bài viết này thảo luận về công cụ JavaTOC doclet, cách sử dụng và mở rộng nó. Cách tiếp cận này sử dụng giải pháp chuẩn Javadoc và sử dụng JavaTOC doclet mà tôi đã phát triển để tạo ra hệ trợ giúp trình bổ sung Eclipse. Công cụ JavaTOC doclet sinh ra các tệp định h ướng mục lục XML cần thiết cho hệ trợ giúp Eclipse, tài liệu tham chiếu Sun Javadoc API ở định dạng HTML. Để hiểu được cách tiếp cận này, tôi đã đưa vào một ví dụ minh họa có sử dụng Sun Javadoc và công cụ JavaTOC doclet (sử dụng giao diện dòng lệnh - Command Prompt). Về đầu trang Cấu trúc tham chiếu Eclipse Javadoc API được tạo ra với JavaTOC doclet Các ràng buộc thiết kế Để trở thành một thư ký kỹ thuật (người phát triển thông tin Java API) có kỹ năng cao, bạn phải đạt được trình độ hiểu biết thông thạo về ngôn ngữ Java, các công cụ sinh tài liệu tham chiếu Java API và các kỹ năng. Bạn có thể chạy JavaTOC doclet và Javadoc để sinh ra tài liệu tham chiếu Java API, định hướng mục lục và cấu trúc trình bổ sung. Hoặc bạn có thể chỉ chạy JavaTOC doclet để tạo ra định hướng mục lục từ các tài liệu có sẵn mà lập trình viên đã tạo ra và chuyển cho bạn. Luồng công việc Với mỗi trình bổ sung mà bạn muốn đóng góp cho hệ trợ giúp Eclipse (phần tham chiếu Java API), thì nói chung cần xử lý theo luồng sau: • Chạy JavaTOC doclet để tạo ra tất cả các tệp trình bổ sung cần thiết cho hệ trợ giúp Eclipse (plugin.xml, primary.plugin.toc.xml, META- INF/MANIFEST.MF, build.properties, và plugin.properties). Tệp plugin.xml, mở rộng điểm mở rộng org.eclipse.help.toc, cần phải chỉ ra: 1. Một tệp mục lục XML, nếu bạn chỉ có một ít các gói Java. 2. Nhiều tệp mục lục XML, khi bạn có nhiều gói Java. • Chạy Javadoc (Sun Microsystems) trên các tệp mã nguồn Java của bạn để tạo ra các tệp HTML cho tài liệu tham chiếu Java API. • Kiểm tra tài liệu tham chiếu Java API đã được tạo ra. Ant là hệ thống xây dựng Java mà ngày nay dường như tất cả mọi người đều đang sử dụng. Nếu bạn chưa từng làm việc với Ant thì hãy xem ở trang thông tin Jakarta, hoặc "Open Source Java: Ant" (Java mã nguồn mở: Ant). Cách yêu thích của tôi để chạy công cụ JavaTOC doclet là thông qua hệ thống xây dựng Ant, nhưng trong bài viết này tôi sẽ chỉ cho các bạn cách sử dụng JavaTOC doclet từ giao diện dòng lệnh (Command Prompt). Xây dựng các tệp đầu ra mục lục XML với dòng lệnh Các ngôn ngữ lập trình máy tính hỗ trợ việc tạo tài liệu mã nguồn bằng cách cung cấp các ký hiệu đặc biệt để đánh dấu bắt đầu và kết thúc của các đoạn mô tả mã nguồn. Các ký hiệu và mô tả này được coi chung là các chú giải. Ngôn ngữ lập trình Java hỗ trợ ba loại chú giải: nhiều dòng, dòng đơn và doc. Bộ công cụ JavaTOC Doclet phiên bản 1.0.0 cung cấp giao diện dòng lệnh như là một sự lựa chọn cho nhữ ng người dùng ít hiểu biết về Ant để họ có thể sử dụng bộ công cụ một cách dễ dàng. 1. Hãy chắc chắn rằng Javadoc đã được cài đặt trên đường dẫn của bạn. ( \jdk1.5.0_06\bin\javadoc.exe) o GHI CHÚ: thông thường Javadoc sẽ có một đường dẫn có dạng C:\Program Files\Java\jdk1.5.0_06\bin. 2. Tải về tệp JavaToc Doclet ZIP và giải nén tệp đó vào thư mục bạn chọn (ví dụ, C:\doclet\ trên Windows). Một thư mục JavaTOC với các thư mục con bin\, demo\ và doc\ sẽ được tạo ra. o Thư mục bin chứa các lớp Java bạn cần để chạy phần mở rộng doc như là các thư viện jar. (DocletTOC.jar) o Thư mục doc chứa tài liệu hướng dẫn JavaTOC và (ví dụ) tài liệu API trình bổ sung org.dita.dost.doc ở định dạng HTML. o Thư mục tài nguyên src chứa các tệp nguồn Java mà bạn có thể sử dụng cho ví dụ ở đây. (bạn có thể tài về các tệp nguồn trực tiếp từ trang SOURCEFORGE: DITA-OT1.3_src.zip ) 3. Sử dụng tùy chọn @packages để đặt các gói có tên kiểu đủ tiêu chuẩn vào một tệp độc lập. 4. Chạy lệnh sau từ thư mục c:\doclet> javadoc @tocdoclet @options @packages (Từ ví dụ 1 đến ví dụ 3) Ví d ụ 1. tocdoclet -doclet com.ibm.malup.doclet.config.TOCDoclet -docletpath C:\doclet\bin\TOCNavDoclet.jar Ví dụ 2. các tùy chọn -sourcepath src -d com.ibm.doc_plugin_name -overview src/overview-summary.html -doctitle 'Navigation label' -version 'plugin_version' -pluginid plugin_id -provider 'plugin_provider_name' -anchor 'plugin_name' Ví dụ 3. các gói com.ibm.package1 com.ibm.package2 com.ibm.packageN Ví dụ 4. removefiles source\ \ \package1\fileA.java,source\ \ \package2\fileB.java, , , source\ \ \packageN\fileN.java 5. Bằng cách dùng trình soạn thảo NotePad để mở, bạn có thể sửa các tệp này. o JavaTOC doclet gán các giá trị tên trình bổ sung, id, phiên bản và tên nhà cung cấp cho dự án trình bổ sung Eclipse của bạn, thể hiện trong ví dụ 2. Điểm mở rộng từ trình bổ sung org.eclipse.help.toc nhận biết đây là một trình bổ sung cho hệ thống trợ giúp. Tệp doclet.toc.xml được tham chiếu đến như là mục lục cho trình bổ sung này; tệp này sẽ cung cấp dữ liệu cho thông tin có thứ bậc ở khung bên trái của cửa sổ trợ giúp Eclipse. o Tệp packages có nội dung giống như được thể hiện trong ví dụ 3. 6. Chạy lệnh: javadoc @tocdoclet @options @packages @removefiles — xóa tất cả các lớp mà bạn không muốn để hiển thị ra (ví dụ 4). Bảng các tham số đề xuất được cung cấp bởi JavaTOC doclet: Tham số Mô tả -d <destinatio n directory> Chỉ ra thư mục đích cho tài liệu được tạo ra. Theo ngầm định, đây là thư mục hiện tại (thư mục được chỉ định bằng đường dẫn "."). -doclet <class> Tạo ra đầu ra thông qua doclet thay thế. Để chạy doclet, bạn sẽ cần phải chỉ ra lớp doclet trên dòng lệnh Javadoc, sử dụng tùy chọn: -doclet <class> - sourcepath <pathlist> Chỉ ra chỗ tìm các tệp nguồn. Theo ngầm định thì src là thư mục hiện tại. - docletpath <path> Chỉ ra chỗ tìm các tệp lớp doclet -doctitle <html- code> Bao gồm tiêu đề cho trình bổ sung Eclipse. Điều này được phản ánh trong tệp manifest.mf: Plugin.name = Building MDA RXE -overview <file> Chỉ ra chỗ tìm tài liệu tổng quan (tệp HTML). —version <plug- in_version> Chỉ ra các chi tiết id phiên bản trình bổ sung. —provider <plug- in_provider > Chỉ ra các chi tiết tên nhà cung cấp trình bổ sung. -anchor Việc liên kết được chỉ ra bằng cách sử dụng tham chiếu tới mục lục đủ tiêu chuẩn, ví dụ như là <toc link_to=" /the_other_plugin_id/path/to/toc.xml#anchor_id"/> -notree Phần đóng góp org.eclipse.help.toc chỉ ra một hoặc một số các tệp XML kết hợp, các tệp này chứa cấu trúc của trợ giúp của bạn và tích hợp của nó với trợ giúp được đóng góp bởi các trình bổ sung khác. Nếu bạn định tạo tài liệu cho một dự án đầy đủ thì chỉ ra là sẽ tạo nhiều tệp mục lục XML. GHI CHÚ: Nếu quên tham số cờ này thì sẽ chỉ tạo ra một tệp mục lục XML 7. Doclet tạo ra các tệp XML đầu ra cho trình bổ sung, và một số tệp hữu ích tại c:\doclet\com.ibm.doc_plugin_name, giờ đây là thư mục trình bổ sung của bạn: o plugin.xml o plugin.properties o .project o META-INF\MANIFEST.MF o com.ibm.packageN.toc.xml — các tệp XML mục lục để xây dựng cây định hướng trong trình duyệt trợ giúp o buildJavaDoc.xml — tệp ANT để chạy công cụ JavaDoc từ môi trường Ant. o buildJavaDoc.bat — tệp BAT để chạy công cụ JavaDoc. 8. Chạy JavaDoc từ giao diện dòng lệnh (buildJavaDoc.bat) để tạo tệp HTML cho tài liệu API. Về đầu trang Sử dụng JavaTOC doclet để tạo một tệp mục lục XML Đến giờ thì chúng ta vừa nói về doclet, hãy tiếp tục với ví dụ thực sự, sử dụng JavaTOC doclet với các tệp nguồn DITA-OT 1.3 (DITA-OT1.3_src.zip) làm ví dụ của chúng ta. Tệp mục lục định nghĩa các điểm mục nhập khóa thành các tệp nội dung HTML bằng cách định nghĩa các chủ đề đã được dán nhãn được ánh xạ t ới các tệp HTML, và hoạt động giống như mục lục của một tập các nội dung HTML. Đôi khi các tệp mục lục này được đề cập đến như là các tệp định hướng bởi vì chúng mô tả cách định hướng nội dung HTML. Một trình bổ sung có thể có một hoặc nhiều tệp mục lục. Chạy ví dụ org.dita.dost Chạy tệp bat: C:\doclet\JavaTOC>TOCDoclet_dost.bat (Từ ví dụ 5 tới ví dụ 8) [...]... dụng để tạo tài liệu trợ giúp tham chiếu Java API 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 liệu này sau đó có thể được sử dụng để tạo ra định dạng đầu ra XML và HTML cho các hệ thống trợ giúp Eclipse có sẵn Chúng ta đã xem cách sử dụng JavaTOC doclet để xây dựng tài liệu nền Eclipse Giải pháp mã nguồn... Sau khi sửa hoặc thêm tài liệu API mới vào tệp mã nguồn, bạn nên tạo ra tài liệu để khẳng định chắc chắn và kiểm tra rằng kết quả thu được là những gì bạn đã mong đợi Bây giờ lấy trình bổ sung của bạn và thả nó vào thư mục các trình bổ sung của nền, khởi chạy Eclipse và chọn Help -> Help Contents Chạy JavaDoc để tạo ra tệp HTML Để tạo ra tài liệu tham chiếu Java API (định dạng HTML) cho ví dụ... trong tài liệu này là trách nhiệm của người đọc và phụ thuộc vào khả năng của người đọc để đánh giá và tích hợp chúng vào môi trường hoạt động của mình Về đầu trang Kết luận Nguồn tham chiếu Java API được sở hữu bởi các lập 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 tham. .. một tài liệu XML Nhu cầu duyệt được và tìm kiếm được được thỏa mãn với cách tiếp cận thông tin có cấu trúc này, sử dụng XML Tài liệu được cung cấp với một danh mục có thể rút gọn lại được ở bên trái và tài liệu HTML ở bên phải Chạy JavaDoc để tạo tệp HTML Chạy JavaDoc từ giao diện dòng lệnh từ thư mục C:\doclet\JavaTOC\demo\output\org.dita.dost.doc (buildJavaDoc.bat) để tạo ra các tệp HTML cho tài liệu. .. pháp mã nguồn mở này có thể đơn giản hóa việc xây dựng tài liệu của bạn, cho phép bạn làm chỉ làm việc với doclet, trình bổ sung và tài liệu tham chiếu sẽ được tạo ra cho bạn Theo thời gian sẽ có ngày càng nhiều các bổ sung Trong các bài viết tiếp theo của loạt bài về lĩnh vực developerWorks XML, Tài liệu Java API được tổ chức trong đặc tả DITA API như thế nào, Tôi sẽ mô tả quá trình sử dụng công cụ... /writer/DitaWriter.html"/> Bây giờ thì chúng ta đã có tất cả các tệp trình bổ sung, các tệp này đã được đưa vào cho hệ trợ giúp Eclipse Bạn có cấu trúc của tài liệu tham chiếu Java API, tài liệu này giúp định hướng trong trình bổ... ra nhiều tệp mục lục XML Một tệp Java API đơn điển hình có thể chứa từ bảy tệp gói trở lên Với JavaTOC doclet, bạn chỉ duy trì một tệp (package.txt), và phần còn lại sẽ được tạo ra Bạn có thể giảm đáng kể thời gian phát triển và có thể tập trung vào việc làm tài liệu API bởi vì JavaTOC tạo ra 100% mã trợ giúp trình bổ sung cho bạn Chạy cùng ví dụ org.dita.dost Chạy JavaTOC doclet giao diện dòng lệnh... directory C:\doclet\JavaTOC>javadoc @tocdoclet options.org.dita.dost @packages (Ví dụ 13) Ví dụ 13 options.org.dita.dost -sourcepath demo/src -d demo/output2/org.dita.dost.doc -overview src/overview-summary.html -provider XYZ -doctitle 'Building DITA output' -notree trong đó tôi giới thiệu tham số -notree: Tham số Mô tả Chỉ ra là tạo nhiều tệp mục lục XML -notree GHI CHÚ: Nếu thiếu tham số này thì sẽ... tài liệu tham chiếu API C:\doclet\JavaTOC\demo\output\org.dita.dost.doc>javadoc -sourcepath src -d doc -doctitle "Building DITA output" -overview src\overview.html org.dita.dost.index org.dita.dost.invoker org.dita.dost.log org.dita.dost.module org.dita.dost.pipeline org.dita.dost.platform org.dita.dost.reader org.dita.dost.util org.dita.dost.writer org.dita.dost.exception Về đầu trang Sử dụng JavaTOC... 1 Thư mục trình bổ sung Để tiện lợi và giảm kích thước tệp, Eclipse cho phép bạn giữ tất cả các tài liệu thực sự của mình (các tệp HTML) trong một tệp ZIP được gọi là doc.zip, do vậy bạn có thể sử dụng cấu trúc thư mục được hiển thị trong hình 2 Hình 2 Cấu trúc thư mục của doc.zip Về đầu trang Xem tài liệu của bạn Cách dễ nhất để kiểm tra trình bổ sung của bạn là đơn giản chỉ việc thả toàn bộ thư . Tài liệu tham chiếu Java API Phần 2: Sử dụng JavaTOC doclet để sinh cấu trúc tham chiếu Eclipse Javadoc API Mariana Alupului, Phát triển Thông tin,. này, Tài liệu tham chiếu Java API được tổ chức trong trợ giúp Eclipse như thế nào , tôi đã giới thiệu một cách tiếp cận khác để tạo ra tài liệu tham chiếu giao diện lập trình ứng dụng (API) Java. gói Java. 2. Nhiều tệp mục lục XML, khi bạn có nhiều gói Java. • Chạy Javadoc (Sun Microsystems) trên các tệp mã nguồn Java của bạn để tạo ra các tệp HTML cho tài liệu tham chiếu Java API.