掲示板一覧   -   トピック一覧
   EA ソースコード生成・コード生成テンプレート
     戻り値のコメントを記入する場所について


スレッド表示 | 新しいものから 前のトピック | 次のトピック | 下へ
投稿者 トピック
未登録ゲスト
投稿日時: 2007-7-2 14:45

戻り値のコメントを記入する場所について

いつもお世話になります。

戻り値のコメントを書く場所について質問があります。
現在C#で開発を行なっていますが、
ソースの生成で戻り値のコメントを出力したいと思っております。

C#のXMLによるコメントの書き方では<returns>なのですが、この場所にコメントを出力するためには、どのようにすれば良いのでしょうか。

sugimoto
投稿日時: 2007-7-2 15:06
EA Administrator
投稿: 1895

Re: 戻り値のコメントを記入する場所について

操作の一般タブ内のノート欄に「@returns」に続けて戻り値の
コメントを記述すると、C#のコードに「<returns>コメント</returns>」
として出力されます。

ただし、現状ノート欄の「@returns」の前に、何かしらのコメントが
ないと正しく出力されません。

この点につきましては、機能改善いたします。
未登録ゲスト
投稿日時: 2007-7-2 15:26

Re: 戻り値のコメントを記入する場所について

一般タブ内のノート欄に@returnsを追加して、その後ろにコメントを記入しても出力されません。

なにがいけないのでしょうか

バージョン情報
EA:6.5.805
sugimoto
投稿日時: 2007-7-2 15:40
EA Administrator
投稿: 1895

Re: 戻り値のコメントを記入する場所について

<returns></returns>が正しく出力されないということでしょうか?

ノート欄の「@returns」の前に、何かしらのコメントを記入されていますでしょうか?
現状、<returns></returns>を出力するためには、「@returns」の前に
コメントがあることが必要になります。

コメントがない場合は、「@returns」がそのまま出力されてしまいます。

ご確認お願いいたします。
未登録ゲスト
投稿日時: 2007-7-2 15:58

Re: 戻り値のコメントを記入する場所について

@returnsの前のコメントがあります。

下記のような形式で書いております。
コメント@returns戻り値

そうすると<summary>にコメントが出力されており、コメント以下のデータはどこにも出力されていません。

sugimoto
投稿日時: 2007-7-2 16:16
EA Administrator
投稿: 1895

Re: 戻り値のコメントを記入する場所について

申し訳ございません。

こちらの説明が不足しておりました。

以下のようにコメントの後に改行を入れてください。
-----------------
コメント
@returns戻り値のコメント
-----------------

お手数おかけしてしまい、申し訳ございませんでした。

ご確認のほど、よろしくお願いいたします。
未登録ゲスト
投稿日時: 2007-7-2 19:55

Re: 戻り値のコメントを記入する場所について

改行をいれても、症状はかわりません。
何か設定がおかしいのでしょうか。
sugimoto
投稿日時: 2007-7-3 9:44
EA Administrator
投稿: 1895

Re: 戻り値のコメントを記入する場所について

お手数おかけしており、申し訳ございません。

1点見逃している箇所がありました。

「@returns」の後に半角スペースが必要です。
また、弊社ではコメントの後に改行をいれて確認しておりましたが、
「@returns」の後に半角スペースがあれば改行は不要なようです。

混乱を招いてしまい申し訳ございません。

以下のどちらかでご確認ください。

------------------------------------------------
コメント
@returns(半角スペース)戻り値のコメント
------------------------------------------------
または
------------------------------------------------
コメント@returns(半角スペース)戻り値のコメント
------------------------------------------------

お手数おかけしておりますが、ご確認お願いいたします。

なお、本件につきましては、ソースコードにご希望のコメントを
記述しておいてモデルに読み込み、ノート欄の記述方法を確認
する方法もあります。
未登録ゲスト
投稿日時: 2007-7-3 11:55

Re: 戻り値のコメントを記入する場所について

@returnsの後ろに半角スペースを入れることで、戻り値を出力することができました。

戻り値のコメントですが、引数のコメントと同じく重要な要素なので、一般のコメントの中ではなく、別途戻り値のコメントという欄があっても良いと思いました。

sugimoto
投稿日時: 2007-7-3 13:00
EA Administrator
投稿: 1895

Re: 戻り値のコメントを記入する場所について

戻り値のコメントが出力できたようで安心いたしました。

戻り値のコメント入力欄を、操作のノートとは別のエリアとして
設けるというご提案につきましては、機能改善要望として
検討いたします。

なお、操作の戻り値に関する情報につきましては、コメント以外
にも例えば、ポインタ型を指定したいなどのご要望をいただいており、
このようなご要望と合わせて見直しを行っていきたいと思います。
スレッド表示 | 新しいものから 前のトピック | 次のトピック | トップ