Tcl スクリプト内のすべてのプロシージャには、必須のメタコメントを含める必要があります。この規則は、名前空間からエクスポートされているユーザー プロシージャとヘルパー プロシージャの両方に適用されます。メタコメントが含まれていない場合、Vivado Tcl Store リンターによりエラー メッセージが生成されます。エクスポートされたすべてのプロシージャのメタコメントには、完全な情報が含まれていることが必要です。ヘルパー プロシージャのメタコメントは空にすることが可能ですが、メタコメントは宣言する必要があります。
メタコメントは、プロシージャの機能の簡単な説明、カテゴリ情報、プロシージャでサポートされるコマンド ライン オプションのリストなどの情報をシステムに提供します。メタコメントは、プロシージャ定義とコードの最初の行の間に挿入する必要があります。すべてのメタコメントが必須です。
必須のメタコメントは、次のとおりです。
- Summary
- プロシージャの機能のサマリ。複数行にできます。このサマリは、[Xilinx Tcl Store] ダイアログ ボックスにプロシージャの説明として表示されます。
- Argument Usage
- プロシージャのコマンド ライン引数のリスト。ヘルプ システムを構築するのに使用されます。このガイドの別のセクションで、サポートされるフォーマットを示します。
- Return Value
- プロシージャの戻り値。ヘルプ システムを構築するのに使用されます。
- Categories
- アプリのカテゴリのリスト。アプリをリストする Vivado ヘルプ システムのカテゴリを指定します。「
Categories:」の後にカテゴリをカンマで区切ってリストします。慣習として、最初にxilinxtclstoreを指定し、その後にアプリ名を指定します。
次に、ユーザー プロシージャに必要なメタコメントの例を示します。
proc ::tclapp::mycompany::template::my_command1 { args } {
# Summary: Multi-lines summary of
# what the proc is doing
# Argument Usage:
# [-verbose]: Verbose mode
# [-file <arg>]: Report file name
# [-append]: Append to file
# [-return_string]: Return report as string
# [-usage]: Usage information
# Return Value:
# return report if -return_string is used, otherwise 0. If any error occur TCL_ERROR
is returned
# Categories: xilinxtclstore, template
# The code for the proc starts below
…
}注記: サブ名前空間にヘルパー プロシージャと共に作成されたプロシージャ
my_command1 ではなく、名前空間からエクスポートされるユーザー プロシージャに詳細なメタコメントを含める必要があります。次に、ヘルパー プロシージャのメタコメントの例を示します。すべてのメタコメントが定義されていますが、空です。
proc ::tclapp::mycompany::template::my_command1::lshift {inputlist} {
# Summary :
# Argument Usage:
# Return Value:
# Categories:
# The code starts below
…
}スクリプトに含まれるすべての Tcl スクリプトにすべてのメタコメントを含める必要がありますが、詳細情報を含める必要があるのは、名前空間からエクスポートされるユーザー プロシージャです。