在產生的程式碼中併入 Javadoc 註解

若要併入 Javadoc 註解,請依您平常的方式產生程式碼。

關於這項作業

依預設,在Java 開發人員的 IBM® Rational® Rhapsody® 專案中可使用 Javadoc 註解產生作業。

在產生的程式碼中,可看見以您為模型元素提供的說明為基礎的 Javadoc 註解。作業的註解同時包括您為作業引數提供的任何說明。

如果在您的程式碼中未看見此類註解,請針對所使用的配置開啟「特性」視窗,然後確認有選取設定標籤上的產生 JavaDoc 註解勾選框。如果有選取此選項,而您在產生的程式碼中仍未看見 Javadoc 註解,請閱讀對 Javadoc 註解進行疑難排解中列出的建議。

除了產生這些基本的 Javadoc 註解以外,您可以讓 Rational Rhapsody 包括下列標準 Javadoc 標籤:author、deprecated、return、see、since、version。若要在產生的程式碼中併入這些 Javadoc 標籤,請執行下列動作:

程序

  1. 針對您要記錄的模型元素開啟「特性」視窗。
  2. 標籤索引標籤上顯示的各種標籤提供值以新增 Javadoc 內容。
  3. 針對您要記錄的每一個模型元素重複此程序。
  4. 產生程式碼。

結果

在程式碼包括 Javadoc 註解後,您可以使用標準 Javadoc 程序來產生 Javadoc 報告。


回饋