掲示板一覧   -   トピック一覧
   EA ソースコード生成・コード生成テンプレート
     doxygenフォーマットのコード生成テンプレート


スレッド表示 | 新しいものから 前のトピック | 次のトピック | 下へ
投稿者 トピック
sugimoto
投稿日時: 2008-10-1 17:51
EA Administrator
投稿: 1895

doxygenフォーマットのコード生成テンプレート

○ご質問

doxygenのフォーマットで、ソースコードへコメントを出力したいと考えています。
ファイルヘッダについては、コード生成テンプレートをカスタマイズできたのですが、
操作(メソッド)については思うようにカスタマイズできていません。

下記のようなフォーマットでコメントを出力したいのですが、
どのようにすればよいですか?

/**
* 操作の名称
*
* 操作のノート
*
* @param パラメータ名 パラメータのノート
* @param ・・・・・・・
*
* @retval 戻り値 戻り値の詳細
* @retval ・・・・・・
*
*/


○回答

まず、変更対象は「Operation Notes Impl」テンプレートとなります。
(.cpp の操作のコメントになります)

対応方法の一例としましては下記となります。

「操作の名称」「操作のノート」の取得方法は
下記ヘルプのフィールド置換マクロをご確認ください。
 Enterprise Architectの拡張(SDK) > コード生成テンプレートフレームワーク
 > コード生成テンプレートフレームワーク > コード生成テンプレートの文法 > マクロ
 > フィールド置換マクロ

パラメータのコメント行につきましては
下記ヘルプのリストマクロを利用する方法がございます。
 Enterprise Architectの拡張(SDK) > コード生成テンプレートフレームワーク
 > コード生成テンプレートフレームワーク > コード生成テンプレートの文法 > マクロ
 > 制御マクロ

戻り値のコメント行につきましては
戻り値は前述のフィールド置換マクロで取得可能ですが
「戻り値の詳細」のようなコメントを入力する場所は無いので
操作のノート欄を利用する形になるかと思います。

コメント全体の体裁につきましては
下記ヘルプの機能マクロで調整する方法がございます。(例:WRAP_COMMENT)
 Enterprise Architectの拡張(SDK) > コード生成テンプレートフレームワーク
 > コード生成テンプレートフレームワーク > コード生成テンプレートの文法 > マクロ
 > 機能マクロ


尚、コード生成テンプレートのカスタマイズ方法につきましては
下記サイトにある「Enterprise Architect ソースコード生成ルール
カスタマイズ 実践セミナー」がご参考になるかと思いますので
是非ご確認ください。
https://www.sparxsystems.jp/seminar/seminar.htm
スレッド表示 | 新しいものから 前のトピック | 次のトピック | トップ