8.2 コマンドの説明形式
コマンドは、機能、形式、引数などの項目に分けて説明しています。コマンドの説明形式を次の表に示します。
項番 |
説明項目 |
内容 |
---|---|---|
1 |
機能 |
コマンドの機能について説明しています。 |
2 |
形式 |
コマンドの入力形式について説明しています。 |
3 |
引数 |
コマンドの引数について説明しています。 |
4 |
格納先 |
コマンドの実行ファイルの格納先について説明しています。 |
5 |
注意事項 |
コマンドを実行する上での注意事項について説明しています。 |
6 |
戻り値 |
コマンドの戻り値について説明しています。 |
7 |
使用例 |
コマンドの使用例について説明しています。 |