問題タブ [asdoc]

ASDoc Ant タスクを機能させようとしています。

実行すると、ASDoc から「エラー: タイプが見つからないか、コンパイル時の定数ではありませんでした: XXX」のようなエラーが表示されます。ASDoc を手動で実行するときは、「asdoc -source-path src -doc-sources src」とします。-source-path 値を省略すると、同じエラーが発生します...では、Ant タスクを機能させるにはどうすればよいでしょうか?

Flex Builder UI を介してプロジェクトで ASDoc を実行する方法はありますか? または、それを行う優れた (できれば無料の) プラグインはありますか?

そのためのUIがない場合、おそらくAntを介して、プロジェクトをビルドするときに自動になるように設定する方法に関するチュートリアルへのリンクがありますか?か何か？（複数の質問で申し訳ありません）

つまり、組み込みのECMAオブジェクト（文字列、数値、オブジェクト、関数、正規表現、エラー、ブール値など）です。

配布している Flash (AS3) コンポーネント ライブラリがあり、リリースごとに完全に文書化されていることを確認したいと考えています。Microsoft の C# 用の自動ドキュメント生成で私が本当に気に入った点の 1 つは、ドキュメントのタグ付け形式でドキュメント化されていないパブリック メンバーに対して、(コンパイルのたびに) コンパイラに警告を生成させることができることです。

これは、すべてのコードを完全に文書化したことを確認するのに非常に役立ちました。

ASDoc で同様の機能を有効にする方法はありますか?

アドバイスやヒントをありがとうございます。これが Eclipse / Flex Builder 内から機能することを望んでいますが、Ant を使用しても問題ありません。

Flex 3 ライブラリ プロジェクトに対して ASDoc をコンパイルしようとしています。私たちの問題は、ASDocs が、ライブラリ内で作成および使用されているカスタム mxml コンポーネントの認識を拒否することです。

たとえば、ライブラリにカスタムの mxml AdvancedButton コントロールがあり、それをライブラリ内の別の mxml クラスで使用しようとすると、ASDocs コンパイラは親クラス ファイルで「エラー: タイプが見つからないか、またはありませんでした」というエラーを出力します。コンパイル時の定数: AdvancedButton".

カスタム コンポーネントを拡張しようとすると、エラーが発生します。そのため、ライブラリに Button を拡張する AdvancedButton と AdvancedButton を拡張する ExtraAdvancedButton が含まれている場合、ASDocs は「コンポーネント クラス 'ExtraAdvancedButton' の指定された基本クラス 'AdvancedButton が見つかりません」になります。

一方、AdvancedButton が外部ライブラリから参照されている場合、エラーは発生しません。

ファイルが .mxml ではなく .as である場合、これは問題ではないようです。ただし、私たちの場合、degrafa ベースのコンポーネントをネストしています。

アイデアは大歓迎です。

この質問は、ASDoc を使用して AS3 からドキュメントを作成することに関するものです。Flex などからこれを行っているわけではなく、コマンド ラインを使用しているだけです。すべて正常に動作し、ASDoc はエラーを返しませんが、結果のドキュメントのリンクの一部が壊れています。

具体的には、ドキュメントの他の部分 (同じクラスを含む) のプロパティまたはメソッドへのリンクがあるすべての場所で、リンクはパッケージに対応するフォルダーを 2 倍にしてしまいます。

たとえば、私がドキュメントを作成しているとしますmyPackage.MyClass。MyClassというプロパティがありMyProperty、ドキュメントのどこかに次のような行が含まれている場合:

次に、ドキュメントが正しく解析され、「参照:」リンクが正しく作成されますが、最終的には

もちろん、実際のファイル システムにはmyPackageフォルダが 1 つしかありません。

ASDoc コマンドの関連部分は次のようになります。

リンクのベース URL を指定する ASDoc 引数、またはそれらの行に沿った何かが欠落している可能性がありますか? これが単純なバグである場合、多くの人にとって明らかな問題ですが、Google でこの問題に関する検索結果を見つけることができないため、私の作業仮説は、Flex から ASDoc を実行しているユーザーには発生しないということです。省略しました。

助けてくれてありがとう！

TypeOneError の提案で、さまざまな種類の @see リンクを試しました。これらがうまく機能することがわかりました：

• @see some.package
• @see ClassName
• @see ClassName#property

これらは機能しませんが：

• @see #property
• @see full.package.ClassName
• @see full.package.ClassName#property

少し悪いのは、すべてのナビゲーション リンクが機能するにもかかわらず、自動生成されたタイプのリンクで同じ二重パスが発生することです。たとえば、各メソッドのシグネチャが表示されている場合、メソッドがドキュメントにあるクラスを返す場合、そのリンクは壊れています。

HTML も調べたところ、問題はページのベース URL などにあるようには見えず、単にリンクの一貫性がないことがわかりました。したがって、連続した@seeリンクの列では、上記の規則に従って、 にClassName.htmlリンクするものとにリンクするものがあります。package/ClassName.htmlちなみに、これはすべて、ページがフレームで表示されているかどうかに関係なく当てはまります。

私が何かを理解した場合の詳細情報ですが、回避策のアイデアは大歓迎です。

更新:いくつかの詳細: Flex 3 に付属していたことを除いて、正確な SDK バージョンはわかりませんが、引数なしで ASDoc を実行すると、次のように報告されますAdobe ASDoc Version 3.3.0 build 4852。クラスパスディレクトリに配置されたバッチファイルから、これをすべてWindows XPで実行しています。

部分的な解決策: Flex 4 SDK の 4.0.0.7219 ベータ リリースにアップグレードすることによって (およびそこに配布されている ASDoc を使用することによって)、1 つを除くすべての問題が解決されました。これで、すべての@seeタグが期待どおりに機能します。唯一残っている問題は、ドキュメントの一部であるクラスを返すメソッドがある場合、ASDoc が単にリンクを壊してしまうことです。たとえば、署名が であるメソッドがある場合ClassA#getB():ClassB、それがドキュメントに示されている場合、テキスト「ClassB」は「packageName/ClassB.html」ではなく「packageName:ClassB.html」にリンクしています。これは単純なバグのようです。ブレ。

asdoc の実行時に actionscript ファイルに表示されるコメントを取得できません。これは既知のバグですか?

生成されたドキュメントに何も表示されません...何か間違っていますか?

ASDoc を使用してフレックス プロジェクトのドキュメントを作成していますが、バインド可能なメタタグに問題があります。

• Bindable タグにイベント名が関連付けられていない限り、ASDoc は値を記録しません。public Bindable

例えば：

• バインド可能なタグにイベント名が関連付けられていない場合、ASDoc は値の名前の先頭にランダムな文字列を追加します。protected Bindable

例えば：

Bindable要約すると、ASDoc はイベント名のないタグには満足していません。簡単な解決策は、何かを Bindable として宣言するたびにイベント名を指定することです。しかし、flex のドキュメントでは、Bindable タグでイベント名を指定すると、「イベントの生成とディスパッチはあなたの責任です」と書かれています。私のプロジェクトはほぼ完成しており、多くの場所でバインディング (イベント名なし) に依存しているため、戻ってすべてを変更することは現実的ではありません。多くの労力が必要になります。さらに、ドキュメントを作成するために作業コードを台無しにするという考えは、私には恐ろしいように思えます。

asdocを生成する前にすべての[Bindable]インスタンスを置き換えてから元に戻すことが、私が考えることができる唯一の回避策です。[Bindable("blah")]しかし、私はもっと良い方法があるべきだと感じています。

Adobeバグ トラッカーは、パブリック変数の問題が最新のビルドで修正されたと主張しているため、最新の flex SDK (3.4) をダウンロードし、付属の ASDoc で試してみましたが、同じ結果が得られました。

誰でもこの問題に光を当てることができますか?

また、アドビのブログによると、 ASDoc は mxml もサポートするようになりましたが、最新の (flex 3.4) ASDoc を試したところ、mxml asdoc コメント (に埋め込まれています) が、生成された html ページに表示されませんでした。最新の asdoc を個別にダウンロードできるかどうかは誰にもわかりませんか?

asdocが認識して使用する独自のページを作成できるかどうか誰かが知っていますか？たとえば、「はじめに」、「サポート」、「FAQ」のようなページを作成して、ActionScriptクラスの内容を理解するのに役立てたいと思います。

ASDoc を JavaDoc のようにプライベート メンバーをドキュメント化するように設定できますか?