外掛程式說明

Eclipse 平台的說明機能提供您以原始資料構成要素來建構以及提供平台的文件。它不指定文件的結構或顆粒性質。 您可以選取適合您的文件需要的工具和結構。說明外掛程式容許您使用目錄(toc)檔案說明平台的文件結構。

外掛程式的線上說明使用 org.eclipse.help.toc 延伸點來提供。您可以提供線上說明作為程式碼外掛程式的一部份,或在它自己的文件外掛程式中單獨 提供它。

若程式碼和文件團隊是不同群組,或您要減少文件與程式碼的結合,在這些情況下, 將文件分成個別的外掛程式很有幫助。

說明系統的進階特性包括上下文相關說明和參照鏈結(稱為蹦現資訊)以及從文件中呼叫平台程式碼的功能。說明瀏覽器讓您檢視、列印並搜尋文件。

示範這些說明構成要素的最佳方法是建立文件外掛程式。

Copyright IBM Corporation and others 2000, 2003.