リファレンス・トピックのショート・デスクリプションを書く <shortdesc>

リファレンス・トピックのショート・デスクリプション(shortdesc要素)には、コマンド、ステートメント、関数、アプリケーション・プログラミング・インターフェイス(API)、メニューなどの機能を簡潔明瞭に書きます。

リファレンス・トピックは辞書的な情報を提供します。したがって、ショート・デスクリプションに書かれた短い説明を読むだけで、必要としている情報がそこにあるかどうか判断できることが望まれます。

リファレンス・トピックのショート・デスクリプションには、以下のような情報を書くべきです。