新增 Javadoc 標籤

Javadoc 產生機制可讓您定義要使用的新 Javadoc 標籤。

關於這項作業

若要定義 Javadoc 標籤,請執行下列動作:

程序

  1. 選取檔案 > 新增至模型,然後選取檔案 <Rational Rhapsody 安裝路徑>\Share\
    Profiles\JavaDoc\JavaDocProfile.sbs
    ,以建立 JavaDocProfile 的可寫入副本(當產品指出設定檔存在模型中時,請選取取代現有的單位選項)。
  2. 在設定檔中建立 Javadoc 標籤。建立標籤時,請從適用於清單中選取適當的項目。
  3. 為元素的相關類型修改 DescriptionTemplate 內容的值。使用 $<tagname> 以讓產品在 Javadoc 註解中併入標籤文字。
  4. 針對相關類型的特定元素開啟「特性」視窗,然後在標籤標籤上提供您已新增之 Javadoc 的值。

範例

程序

  1. 在設定檔底下建立稱為 codeReviewer 的新標籤。 從適用於清單中選取類別
  2. 針對 JAVA_CG::Class::DescriptionTemplate 內容,將下列字行新增至內容值:[[ * @codeReviewer $codeReviewer]]
  3. 針對模型中的一個以上類別開啟「特性」視窗,然後在標籤索引標籤上,為標籤 codeReviewer 的值輸入 Steve

結果

在進行這些變更後為模型產生程式碼時,這些類別的 Javadoc 註解會包括 @codeReviewer Steve


回饋