掲示板一覧 - トピック一覧 EA ソースコード生成・コード生成テンプレート
C++ JavaDocスタイルのコメント |
| スレッド表示 | 新しいものから | 前のトピック | 次のトピック | 下へ |
| 投稿者 | トピック |
|---|---|
| sugimoto | 投稿日時: 2007-10-30 16:23 |
EA Administrator ![]() ![]() 投稿: 1895 |
C++ JavaDocスタイルのコメント○ご質問
C++のソースコード生成にて、コメントをJavaDocスタイルに設定しています。 1.クラスヘッダをして出力されtる @author @version @created を 外したいのですか、どのようにすればよいですか? 2.メソッドが例外を発生する場合、タグ付き値でthrowsを書けばよい事は 分かったのですが、メソッドコメントに @exception もしくは @throws を追加すにはどうすればよいですか? また、@exception の後ろに説明文を追加したいと思っています。 3. メソッドコメントに @return を追加するにはどうすればよいですか? ○回答 1.コード生成テンプレートを編集することで、@author @version @created に関するコメントを出力しないようにすることが可能です。 コード生成テンプレート(メインメニュー→「設定」→「コード生成 テンプレート」)を開き、左上の言語欄でC++を選択してください。 クラスのノート欄を使用しない場合であれば、 「Class」テンプレート1行目の以下をを削除してください。 %ClassNotes% クラスのノート欄を使用される場合は、 C++のソースコードの設定でJavaDocスタイルが指定されている場合でも、 メソッドコメントをJavaDocスタイルではなく、通常のコメントで出力 するように、コード生成テンプレートを変更することでご対応いただけます。 「ClassNotes」テンプレート11行目を、以下のいずれかの方法で 編集してください。 (デフォルト) %elseIf $style == "JavaDoc"% %JAVADOC_COMMENT($wrapLen)% (変更案1) %elseIf $style == "JavaDoc"% %WRAP_COMMENT(classNotes, $wrapLen, "", "// ")% (変更案2) %elseIf $style == "JavaDoc"% %CSTYLE_COMMENT($wrapLen)% 2.タグ付き値にthrowsが記入されている場合は、自動的にメソッドコメントに @exceptionが出力されるようになっています。 タグ付き値に関する説明文は、タグ付き値のノート欄(タグ付き値サブ ウインドウの左から4つ目のアイコン)に記載できますが、現状、ノート 欄に記載があると、@exception は出力されず、ノート欄の情報のみが、 メソッドコメントに出力されます。 そのため、ノート欄に@exception を含めた記載をしていただくことが 必要になります。 throwsのタグ付き値のノート欄に記載がある場合は、 「@exception (タグ付き値) (ノートの内容)」のように出力された ほうが良いと思いますので、機能改善要望として検討いたします。 3.メソッドのプロパティダイアログの「ノート欄」へ 「@return (メソッドのコメント)」を記載してください。 現状、メソッドの戻り値のためのコメント欄は存在しておらず、 機能改善要望として検討を行っております。 そのため、現状、@return を追加する場合は、メソッドのノート欄に 記載いただいています。 |
| sugimoto | 投稿日時: 2007-11-28 15:22 |
EA Administrator ![]() ![]() 投稿: 1895 |
Re: C++ JavaDocスタイルのコメント引用:
上記(2.)について、 操作のタグ付き値にthrowsを記述した場合に、タグ付き値の ノートの情報と共に@exceptionをコメントに出力できないか、 機能改善要望として検討させていただきましたが、 以下の理由により、この対応は困難であることが判明しました。 --- 操作に複数の例外が定義されている場合、1つのタグ付き値に それらの情報を設定するようになっているが、タグ付き値の ノート欄に記載された情報が、それら複数の例外のうち、どの 例外に該当しているのかは判断することができないため。 また、この複数例外がある場合のタグ付き値の設定方法を 変更してしまうと、すでにタグ付き値を設定しているユーザー にとっては、情報を設定しなおす必要があるため、変更が困難。 --- 上記理由ため、コメントとして出力したい情報は、 タグ付き値の「ノート欄」に、@exception を含んだ情報 「@exception 例外クラス名 説明文」を記載していただきますよう、 お願いいたします。 |
| スレッド表示 | 新しいものから | 前のトピック | 次のトピック | トップ |




