« [UJML2.0]コメント要素を付けられる親要素は何か? | メイン | 比較演算子として、関数_lt()等を使うか、ENTITYを使うか? »

[UJML2.0] var要素でのコメント要素の利用について(2006/10/15)

Ujml_vars  前回のエントリー「[UJML2.0]コメント要素を付けられる親要素は何か?」にて<comment>要素を使うことができる親要素を紹介した。下のものがそれ、

<interface>
<component>
<state-machine>
<var>
<function>
<template>
<state>
<transition>

この中で<var>だけは閉じタグ使わないこと多いが、例えば、

<var name="mScrHeight" type="int"/>

な感じで。

 もし、<comment>要素を使うときは

<var name="mScrHeight" type="int">
    <comment>スクリーンの高さ</comment>
</var>

といった具体で使う。ソースコードの見た目としては、

<var name="mScrHeight" type="int"/><!-- スクリーンの高さ -->

とした方が良いのかもしれないが、以前「[UJML2.0] コメントに何を使いますか?まずはコメント要素の使用を優先的にすべし!」で解説した通り、多少見た目が悪くなっても<comment>要素を使うべきだろう。

 例えば、関数を定義するときには

<function name="calc" type="int">
    <comment>単価と数量から、合計金額を求める。</comment>
    <parameters>
        <var name="price" type="int">
            <comment>商品の単価</comment>
        </var>
        <var name="amount" type="int">
            <comment>商品の数量</comment>
        </var>
    </parameters>
    <return><eval>price * amount</eval></return>
</function>

という感じ。こうすると、関数の仕様書を自動的にジェネレートしたときに引数に説明をつけるのも簡単である。

トラックバック

この記事のトラックバックURL:
https://www.typepad.com/services/trackback/6a00d8341c2e2e53ef00e550aa95238834

[UJML2.0] var要素でのコメント要素の利用についてを参照しているブログ:

コメント

この記事へのコメントは終了しました。