« ESPN サービスは継続、コンテンツプロバイダーとして | メイン | コメントに何を残すべきか?まず、ステート変数の設定時には何かコメントを残そう。 »

[UJML2.0] コメントに何を使いますか?まずはコメント要素の使用を優先的にすべし!(2006/10/04)

 UJML2.0ではコメントの記述方法として新しく<comment>要素が追加された。当ブログではコメントを記述する際、まず<comment>要素を使うことを強く推奨する。できれば、このエントリーを読んだ方に強制したい。(1.5では使えないが)

 これまで、<script>要素中での、

一行コメント //
複数行コメント /* */

や、どこにでも書ける、

複数行コメント <!-- -->

がサポートされてきた。最新のUJML2.0から<comment>要素が仕様として追加された。その意図はさておき(知りたい人はフォーラムで聞いてくれ)、繰り返すが<comment>要素の使用を強く推奨したい。

 というのも、UJMLはxmlベースゆえスタイルシート変換等で俗に言うプログラムやモジュール仕様書(例えばJavaDocのようなHTML等)を簡単に生成できる。このとき<comment>要素を使用していれば、簡単に仕様書にコメントを載せたりできるが、<!-- -->や//、/* */を使われると困る。

 もちろん<comment>要素を書けない場所も多いので、その場合にはそれ以外の方法で書かなければならないのだが。

 今後大規模なUIEngineアプリ開発に従事するエンジニアが増えると思う。まず<comment>要素を使っておくほうが今後の為に良いのでそうして欲しい。(参加プロジェクトにおいてスタイルシート変換で仕様書作成していなくても、いつかの誰かの為に)

 と、具体例で説明したが、<comment>要素を使うということは、「意味あることを書いているよ!」と高らかに宣言しているのだ、と感じる。しつこいようだが、とにかく、<comment>要素を使って欲しい。

トラックバック

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

[UJML2.0] コメントに何を使いますか?まずはコメント要素の使用を優先的にすべし!を参照しているブログ:

» コメントに何を残すべきか?まず、ステート変数の設定時には何かコメントを残そう。 (UIEngine だ)
 前回のエントリーでは、 [UJML2.0] コメントに何を使いますか?まずはコメント要素の使用を優先的にすべし! コメントを残すときにcomment要素を使うことを推奨した。  その中ではコメントとして何を残すべきか?ということには触れていない。コメントに残す内容は基本的には他の言語と同じで良いが、本ブログで推奨するのは、ステート変数に値を設定したら、そこにコメントを残すことである。  というの... [続きを読む]

» [UJML2.0]コメント要素内ではタグは使えないので注意 (UIEngine だ)
 以前のエントリー「[UJML2.0] コメントに何を使いますか?まずはコメント要素の使用を優先的にすべし!」で、できるだけcomment要素を使用してコメントを残すことを推奨したが、comment要素を使う際に注意すべきことがある。それは、 「comment要素内でタグは使えない」 ということだ。例えば、コメントに「入力用にbox要素を10個定義する」と書きたい時に、 comment入力用にbo... [続きを読む]

» [UJML2.0]要素の付けられる親要素は何か? (UIEngine だ)
 以前のエントリー「 [UJML2.0] コメントに何を使いますか?まずはコメント要素の使用を優先的にすべし!」にて、comment要素をコメントとして使うことを推奨した。とは言っても、comment要素を使える親要素は限られているので、今回は何に使えるのかを紹介する。  もし、この手の仕様を知りたければ、オンラインドキュメント Welcome To the UJML Language Refe... [続きを読む]

コメント

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