次の表に、ASDoc コメントで一般に使用される HTML タグと文字コードの一覧を示します。
|
タグまたはコード |
説明 |
|---|---|
| <p> |
新しい段落を開始します。<p> タグは閉じる必要があります。 <p> は、doc コメントの最初の段落(先頭の /** の後の段落)や、タグに関連付けられた最初の段落には使用しないでください。<p> タグは、次のようにそれ以降に使用します。 /** * The first sentence of a main description. * * <p>This line starts a new paragraph.</p> * * <p>This line starts a third paragraph.</p> */ASDoc はコメント内の空白を無視します。AS ファイルを読みやすくするために空白を追加するには、<p> タグを使用しないで、単に空白行を追加してください。 |
| class="hide" |
テキストを非表示にします。このタグは、ソースファイルにドキュメントを追加し、出力にはそのドキュメントを表示しない場合に使用します。 |
| <listing> |
プログラムリスト(サンプルコード)を示します。 このタグは、等幅フォントを使用し、周りのテキストから区別できるように灰色の背景を使用して、個別の段落として書式設定するコードを囲む場合に使用します。<listing> タグは閉じる必要があります。 |
| <pre> |
アルゴリズムまたは式の説明など、等幅フォントでテキストの書式を設定します。<br/> タグは行の終わりには使用しないでください。 <listing> タグはコードに使用します。 |
| <br> |
改行を追加します。このタグは閉じる必要があります。 ほとんどのタグのコメントは自動的に書式が設定されます。通常は、改行を追加する必要はありません。追加の空白を作成するには、代わりに新しい段落を作成します。 このタグは今後はサポートされなくなる可能性があるので、必要な場合にのみ使用してください。 |
| <ul>, <li> |
リストを作成します。これらのタグは閉じる必要があります。 |
| <table> <th> <tr> <td> |
テーブルを作成します。ASDoc スタイルに準拠した基本的なテーブルでは、クラス属性を innertable に設定します。特殊な属性の設定は避けてください。テーブル内のリストなど、ネスト構造のアイテムは避けてください。 ASDoc は、<table>、<th>、<tr>、および <td> タグの定義が含まれる標準の CSS スタイルシートを使用します。これらのタグは閉じる必要があります。 ヘッダーセルには <td> の代わりに <th> を使用して、ヘッダーが正しく書式設定されるようにします。 |
| <img> |
イメージを挿入します。イメージの周囲に適度に空き領域を確保するには、イメージ参照を <p></p> タグで囲みます。キャプションはオプションです。キャプションを使用する場合は、ボールドにしてください。次の例に示すように、<img> タグは、最後に /> を付けて閉じる必要があります。 <img src = "../../images/matrix.jpg" /> |
| <code> |
等幅書式を適用します。このタグは閉じる必要があります。 |
| <strong> |
ボールドのテキスト書式を適用します。このタグは閉じる必要があります。 |
| <em> |
イタリック書式を適用します。このタグは閉じる必要があります。 |
| < |
小なり演算子(<)。最後のセミコロン(;)を必ず入れてください。 |
| > |
大なり演算子(>)。最後のセミコロン(;)を必ず入れてください。 |
| & |
アンパサンド(&)。最後のセミコロン(;)を必ず入れてください。 |
| — |
全角ダッシュ。 |
| ™ |
登録されていない商標記号(™j。この文字はデフォルトで上付きになるので、<sup> タグで囲まないでください。 |
|   |
改行禁止スペース。 |
| ® |
登録商標記号(®)。この文字を上付きにするには、<sup> タグで囲みます。 |
| ° |
温度記号。 |
| @ |
ASDoc コメントでは @ マークを使用せずに、HTML 文字コードの @ を挿入してください。 |
このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート