掲示板一覧   -   トピック一覧
   EA ソースコード生成・コード生成テンプレート
     XMLコメントについて


スレッド表示 | 新しいものから 前のトピック | 次のトピック | 下へ
投稿者 トピック
未登録ゲスト
投稿日時: 2009-12-22 15:35

XMLコメントについて

お世話になります。

操作のノートに以下のように記載すると、
----------
コメント
@returns(半角スペース)コメント
----------
コードを出力したときに、XMLコメントを出力してくるようですが、MSでは以下のURLのタグを推奨しているようです。

https://learn.microsoft.com/ja-jp/previous-versions/5ast78ax(v=vs.80)

<c>
<para>
<see>
<code>
<param>
<seealso>
<example>
<paramref>
<summary>
<exception>
<permission>
<typeparam>
<include>
<remarks>
<typeparamref>
<list>
<returns>
<value>

Enterprise Architectに関してどのタグまで対応しているのでしょうか?
この辺りのドキュメントは無いでしょうか?

以上、よろしくお願い致します。
tkouno
投稿日時: 2009-12-22 15:58
EA Administrator
投稿: 3939

Re: XMLコメントについて

現状では、以下のタグのみに対応しています。
(申し訳ございませんが、ドキュメントとしてはまとめられていません。)

○コメントを入力すると出力されるタグ
<param>
<summary>

○@returnsのような形式でコメント内に入力すると出力されるタグ
<remarks>
<returns>
<value>

未登録ゲスト
投稿日時: 2009-12-24 13:44

Re: XMLコメントについて

引用:


○コメントを入力すると出力されるタグ
<param>
<summary>

○@returnsのような形式でコメント内に入力すると出力されるタグ
<remarks>
<returns>
<value>



@remarksと入力し、ソースコードを出力しても、正しく表示されません。(以下のように出力される)

/// <summary>
/// summaryのコメントです。
///
/// @remarks remarksのコメント
/// </summary>

尚、「@exception ="Exception" 例外コメント」 と記載すると、正しく例外のコメントが出力されます。

頂いている回答と動作が異なっているようなのですが、再度確認して頂き、回答を頂けないでしょうか?

バージョンは、7.5.850
tkouno
投稿日時: 2009-12-24 13:52
EA Administrator
投稿: 3939

Re: XMLコメントについて

ご指摘の件、大変失礼いたしました。

@remarksではなく、@remarkでご確認ください。


また、@exceptionにつきましてもご指摘の通りです。
こちらは当方の確認作業に漏れがありました。

いずれの件も、お手数をおかけし申し訳ございませんでした。

スレッド表示 | 新しいものから 前のトピック | 次のトピック | トップ