ActionScript ファイルを文書化するように DoxyGen を構成するにはどうすればよいですか?
*.as および *.asi ファイルを doxygen の検索パターンに含めましたが、クラス、関数、および変数がそこに表示されません。
ActionScript ファイルを文書化するように DoxyGen を構成するにはどうすればよいですか?
*.as および *.asi ファイルを doxygen の検索パターンに含めましたが、クラス、関数、および変数がそこに表示されません。
doxygenの代わりに、その言語を具体的にサポートするドキュメントジェネレータを使用する必要があります。ActionScript 2の場合、いくつかの選択肢があります。
ActionScript 3を使用している場合、Adobeには、 「 ASDoc 」と呼ばれる無料のドキュメントジェネレーターとオープンソースコンパイラー( Flex SDK )が含まれています。FlashDevelopを使用している場合、最新のベータ版にはASDocを実行するためのGUIが組み込まれているため、コマンドラインで手を汚す必要はありません。
私は DoxyGen を使っていくつかのドキュメントを作成することができました (何と言いましょうか - 私はその特徴と機能が気に入っています)。
入力するファイル タイプのリストに *.as および *.asi を追加します。
選択する:
OPTIMIZE_OUTPUT_JAVA = YES
EXTRACT_ALL = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
AS3 のもう 1 つの問題は、package ステートメントです。パッケージ定義を無視するように DoxyGen に指示する必要があります。これは、cond を使用して簡単に実行できます。したがって、次の行を変更します。
package myPackage {
の中へ
/// @cond
package myPackage {
/// @endcond
これにより、Doxygen は cond と endcond の間の行を無視します。.as ファイルの下部にある閉じ中括弧については、同じことを行う必要がないように思われることに注意してください。
オルテリウスも使えます。シンプルな GUI が付属しているため、ASDoc よりも使いやすく、コードに寛容です。無料でオープンソースですが、Windows のみです。