— boreal-kiss.com

次期Flex SDKからmxmlコンポーネント内でもASDocが使える

ASDoc in MXML – Flex SDK – Confluenceによると、Flex SDK 4 (Gumbo)からmxmlコンポーネントにもASDocが書ける。

(注意: 正確にはASDocのnew versionで使えるようになるとしか記載されていないが、Flex 3.1で出力できず、Flex 4で実際に出力できたという理由から上記のようなタイトルにした。Flex 4より前に使えるようになる可能性はある)

mxml内でのASDoc記法は通常のmxmlコメントアウトの先頭の"<!–"にマイナス記号をもう1コ(計3コ)付け加えるだけ。

<!-- 通常のmxml内のコメントアウト -->
<!--- mxml内のASDocコメント -->

以下の例ではクラス(VBox)へのコメント、クラス内のコンポーネント(Button)へのコメント、Scriptタグ内の通常のASDocコメントがASDocとして出力される(Flex SDK4.0.0.3280で出力確認済)。マイナス記号が繋がってしまってて見づらいけど先頭側は3コある。

<?xml version="1.0" encoding="utf-8"?>
<!---
    ASDoc for the Class
    @see http://opensource.adobe.com/wiki/display/flexsdk/ASDoc+in+MXML
-->
<mx:VBox xmlns="http://ns.adobe.com/mxml/2009" xmlns:mx="library:adobe/flex/halo">
    <!--- 
        ASDoc for the Button below
    -->
    <mx:Button label="Test" click="onClick(event)"/>
    
     <Script>
        <![CDATA[
            /** 
             * ASDoc for the following public function
             * @param e flash.events.Event
             */
            public function onClick(e:Event):void{
                trace(e);
            }   
        ]]>
    </Script>
</mx:VBox>

重要なのはmxタグのネームスペースが変更されている点。

<!-- Flex SDK 3 -->
<mx:VBox xmlns:mx="http://www.adobe.com/2006/mxml">

<!-- Flex SDK 4 -->
<mx:VBox xmlns="http://ns.adobe.com/mxml/2009" xmlns:mx="library:adobe/flex/halo">

そのため<mx:Metadata>や<mx:Script>の記法も変更されている。

<!-- Flex SDK 3 -->
<mx:Metadata>, <mx:Script>

<!-- Flex SDK 4 -->
<Metadata>, <Script>

このへんの記法はFlex 4が開発段階なので今後どうなるかわからないが、mxmlでもASDoc出力できるようになるのは開発側としてはうれしい。

0 comments
Submit comment