ユーザー プロシージャのコマンド ライン引数は、ユーザー プロシージャ内でメタコメント Argument Usage
を使用して説明する必要があります。このメタコメントは、<
command
> -help
が実行されたとき、または [Xilinx Tcl Store] ダイアログ ボックスでプロシージャのヘルプが表示されたときに、ヘルプ システムでメッセージを生成するのに使用されます。次に例を示します。
# Argument Usage:
# [-verbose]: Verbose mode
# [-file <arg>]: Report file name
# [-append]: Append to file
# [-return_string]: Return report as string
# [-usage]: Usage information
ヘルプ システムでこのメタコメント Argument Usage
が使用され、次のメッセージが表示されます。
Syntax:
xilinx::designutils::write_template [-verbose] [-file <arg>] [-append]
[-return_string] [-usage] [-quiet]
Usage:
Name Description
-----------------------------
[-verbose] Verbose mode
Default: 0
[-file] Report file name
Default: None
[-append] Append to file
Default: 0
[-return_string] Return report as string
Default: 0
[-usage] Usage information
Default: 0
[-quiet] Ignore command errors
メタコメント Argument Usage
は、Tcl プロシージャを呼び出す前の Vivado によるコマンド ライン引数の前処理ではないということに注意してください。ヘルプ システムで使用されるだけです。プロシージャの Tcl コードでコマンド ライン引数を処理する必要があります。