IBM Streams 4.3.0

書式規則

ツールキット成果物をマークアップするときに書式規則に従うことによって、 spl-make-doc コマンドでマークアップが正しく解釈され、期待した結果が生成される ことを確実にできます。

コメント・ブロックまたは新規ページの先頭にある文は要約として使用される

コメント・ブロックの先頭にある文は、関連する SPL 成果物の要約説明として使用され、新規ページの先頭にある文はページの要約説明として使用されますコンポジット・オペレーターに関する SPLDOC コメント の次の例では、ネーム・スペース用に生成される文書中のコンポジット・オペレーターのエントリー について要約した Outputs a stream of hello world greeting messages がこれに相当します。
/**
 * Outputs a stream of **hello world** greeting
 * messages. Each message in the stream contains
 * a string with the **hello world** message.
 */

インライン・マークアップを複数行にわたって記述できる

以下の SPLDOC コメントでは、 イタリック体のテキストが 2 コメント行にまたがっています。これらのコメント行は、生成される HTML 内では連結されて 1 つの行になります。

/**
This is *very 
important*.
*/
This is <em>very important</em>.

インライン・マークアップを複数パラグラフにわたって記述することはできない

インライン・マークアップ が複数のパラグラフにまたがっている場合、マークアップ文字はプレーン・テキストとして 扱われます。以下の SPLDOC 例では、太字を表す開始マークアップおよび終了マークアップ ( ** ) は、複数のパラグラフにまたがっているため、解釈されません。

/**
This is **very 

important**.
*/
spl-make-doc コマンドは、次のコードのような HTML を生成します。
<p>This is **very
</p>

<p>important**.
</p>

インライン・マークアップは囲んだテキストに隣接しなければならない

インライン・マークアップ・タグで 囲んだテキストとタグとの間に空白文字が入っている場合、 テキストは HTML 出力ではプレーン・テキストとして解釈されます。次の 例では、文末の太字を表すマークアップ・タグ ( ** ) の前に 空白文字があります。結果として、太字を表す SPLDOC マークアップは プレーン・テキストとして扱われます。

This is **very important **.

spl-make-doc コマンドは、次のコードのような HTML を生成します。

<p>This is **very important **.
</p>
親トピック: SPLDOC マークアップ