掲示板一覧   -   トピック一覧
   Enterprise Architect 全般
     後置コメントの読出設定


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

後置コメントの読出設定

以下のよう形式でコメントされている既存ソースをリバース
エンジニアリングすると、コメントと変数がずれてしまう(次の行の
コメントと認識される)のですが、設定でこれを回避することは
できないのでしょうか。

/// FooBar class.
class FooBar
{
int foo1_; ///< Foo1.
int foo2_; ///< Foo2.
int foo3_; ///< Foo3.
int foo4_; ///< Foo4.
};

私の場合はdoxygen(ドキュメント生成ツール)用の後置コメントで
これが起きているのですが(doxygen の場合は '<' が前方参照の指定)、
このツールにかぎらず、C++ だと、後ろから変数の説明をするソースは
結構見かける気がします。

tkouno
投稿日時: 2004-6-7 16:06
EA Administrator
投稿: 3939

Re: 後置コメントの読出設定

こちらの件、先日別の方からもサポート宛にご質問を頂きましたが
現時点では対応できておりません。
現時点では、「コメントは前にある」という前提になっております。

サポート宛にご質問を頂いた後、対応方法を検討しておりましたが
なかなか難しい問題であると考えております。

「同じ行で後置の場合にはその属性へのコメントとみなす」と
いう解決方法もあるかと思いますが、それですべての場合に
うまくいくのか、という点で悩んでおります。

例えば

//コメント1
int hoge; //コメント2

とあった場合に、果たしてコメント2を自動的に採用してよいものかどうか、
ということです。コメントの内容によってはコメント1を
ノートとして引用してほしいかもしれませんが、その内容(自然言語)を
Enterprise Architectで理解することは、もちろんできません。

後置を採用した場合に、(上記の例で)コメント1が
ノートとして引用されない、といったご報告や、コメント1と2の
両方を連結してノートに入れてほしい、などのご要望があることを恐れています。


この件につきましては、引き続き検討させていただきます。
未登録ゲスト
投稿日時: 2004-6-7 17:49

Re: 後置コメントの読出設定

ご回答ありがとうございます。

引用:

tkounoさんは書きました:

「同じ行で後置の場合にはその属性へのコメントとみなす」と
いう解決方法もあるかと思いますが、それですべての場合に
うまくいくのか、という点で悩んでおります。


少なくとも私のケースでは、規約でコメントは全てdoxygen
(https://www.doxygen.nl/)の後置形式に統一されているため、
上の条件であれば問題ありません。


引用:

この件につきましては、引き続き検討させていただきます。


よろしくお願い致します。

tkouno
投稿日時: 2004-6-10 15:40
EA Administrator
投稿: 3939

Re: 後置コメントの読出設定

こちらの件につきましては、検討の結果
特に問題がなければ、次あるいはその次のビルドで
対応できるのではないかと思います。

(詳細は来週のメールニュースでお伝えします)



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