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

TOC 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...
Nội dung trích xuất từ tài liệu:
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 Tài liệu tham chiếu Java APIPhần 3: Cấu trúc tham chiếu Eclipse Javadoc API đ ược tạo ra thông qua việcchạy JavaTOC doclet và ANTMariana Alupului, Phát triển Thông tin, Rational software, IBMTó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 Eclipsethô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 JavaAPI.Ôn tập nhanhTrong phần 1 của loạt bài này, Tài liệu tham chiếu Java API được tổ chứctrong 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ẩnJavadoc 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 thamchiế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ụclụ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ăngkĩ 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ếuJavadoc API)Hệ thống trợ giúp nền Eclipse cho phép bạn sử dụng điểm mở rộngorg.eclipse.help.contributions để đóng góp trình bổ sung của mình vào trợ giúptrự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 độclậ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 trongcá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 khibạ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ầntử 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 độngchỉ 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ộcCho 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 đềumuố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ùngJavadoc đã đượ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ụngchuẩn Javadoc Generation wizard để tạo ra Javadoc cho tài liệu tham chiếu JavaAPI và JavaTOC doclet cho các tệp định hướng XML mục lục trong môi trườngphá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ậtCustom doclet, và thứ hai thông qua hệ thống xây dựng Ant. Nếu bạn chưa từnglà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ệcThêm các công cụ tạo trình bổ sung JavaTOC (JavaAPITools) vào không gian làmviệ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àokhông gian làm việc. Với ví dụ ở đây, tôi đã tạo ra một dự án Java mớiorg.dita.dost và thêm vào mã nguồn (thư mục src) từ mã nguồn DITA OpenToolkit , 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á ...