掲示板一覧   -   トピック一覧
   EA ソースコード生成・コード生成テンプレート
     Javaソースコード生成時の、import文自動生成とJavadocコメント


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

Javaソースコード生成時の、import文自動生成とJavadocコメント

○ご質問

1.
 多重度が1より大きい関連があり、かつ「既定のコレクションクラス」が
 設定されている場合、フィールドの型が自動的に作成されています。
 この設定で "List<#TYPE#>" のようにクラス名だけ記述した場合、
 合わせて「import java.util.List;」が作成されないため、コンパイル
 エラーになってしまいます。

 このような場合に、import文を自動で作成することはできますか?

2.
 操作のタグ付き値に "throws" を設定することにより、例外の設定が
 できますが、このときに生成されるJavadocコメントを制御することは
 できますか?
 例えば、
 「@exception 例外クラス名 説明」
 のように説明を加えたり、exception を throws にするなどです。

3.
 2.のような例外の設定で、1.と同様に、クラス名だけ記載して
 import文を自動で生成するような設定は可能でしょうか?
 例えば、
 タグ付き値throwsの値に "IOException" と設定した場合に、
 「import java.io.IOException;」を自動で生成するようなことはできますか?


○回答

1.
 以下2)に類似のご質問をいただいております。
 https://www.sparxsystems.jp/forum/modules/xhnewbb/viewtopic.php?topic_id=1645&post_id=3521#forumpost3521

 2)の提案3に関連し、「既定のコレクションクラス」が設定されており、
 多重度が1より大きい関連がある場合に、「import java.util.List;」を
 出力するコード生成テンプレートを作成しましたので、ご確認ください。
 (こちらのテンプレートをご利用になりたい方は、弊社サポートまで
 ご連絡ください。)


2.
 コメントへの説明の付加についてですが、現状タグ付き値のノート欄に
 説明を入力しますと、ノート欄の情報のみがコメントとして出力されています。
 そのため、「@exception 例外クラス名 説明」のように出力する場合は、
 タグ付き値のノート欄にこの内容をそのまま記述する必要があります。

 こちらは、同様のご質問をいただいており、タグ付き値のノート欄に
 記述がある場合は、「@exception 例外クラス名 説明(ノート欄の内容)」
 の形で出力するよう機能改善を検討しております。

 現時点でご要望にお応えすることができず、申し訳ございません。

 なお、操作のタグ付き値に"throws"が設定されている場合は、現状、
 @exception が出力されるようになっており、この点につきましては、
 現状カスタマイズはできません。ご了承ください。


3.
 こちらも1.同様コード生成テンプレートを編集する必要があります。
 操作のタグ付き値の情報を取得し、上記条件の場合は「import java.io.IOException;」
 を返却するような対応になります。
 このコード生成テンプレートを作成しましたので、ご確認ください。
 (こちらのテンプレートをご利用になりたい方は、弊社サポートまで
 ご連絡ください。)

 もう一案としましては、「import java.io.IOException;」が必要なクラス
 に対して、java.io.IOException のクラスを依存関係で結びますと、
 ソースコード生成した際に、import java.io.IOException; が出力されます。

 この後者の方法は1.の場合にも適用できます。この方法は、モデル上に
 クラスを配置する手間はあるものの、視覚的にimport 文が必要なクラス
 であることをモデル上で確認できるメリットもあります。
sugimoto
投稿日時: 2007-11-28 15:25
EA Administrator
投稿: 1895

Re: Javaソースコード生成時の、import文自動生成とJavadocコメント

引用:

こちらは、同様のご質問をいただいており、タグ付き値のノート欄に
記述がある場合は、「@exception 例外クラス名 説明(ノート欄の内容)」
の形で出力するよう機能改善を検討しております。


上記(2.)につきましては、以下理由により、機能改善が困難で
あることが判明しました。申し訳ございません。
https://www.sparxsystems.jp/forum/modules/xhnewbb/viewtopic.php?topic_id=1936&post_id=4190&viewmode=thread&order=ASC#forumpost4190
スレッド表示 | 新しいものから 前のトピック | 次のトピック | トップ