コメント
ACLScript では、スクリプト言語のように COMMENT キーワードを使ってコメントを追加できます。コメントを使うことで、作成するコードを理解しやすくできるとともに、スクリプトを参照、使用、または理解しようとしているユーザーと対話することができます。
コメントの種類
ACLScript では、2 種類のコメントがサポートされています。
- 単一行のコメント COMMENT の後から行末までのすべてのテキストが無視されます。
- 複数行のコメントから成るブロック COMMENT から END キーワードまでのすべての行または空白行が無視されます。
単一行のコメント
単一行のコメントは、作成するスクリプト内の各ステップについて説明したり、変数について説明したりするために使用できます。
COMMENT *** 分析期間の開始日
v_Start_Date = `20150101`
複数行のコメントから成るブロック
複数行のコメントから成るブロックは、スクリプトまたはスクリプトのセクションについて説明する場合に使用できます。
COMMENT
**********************
** このスクリプトのセクションは、インポート対象となるデータを準備します
**********************
END
ヘッダー コメント ブロック
各スクリプトの先頭にスクリプトの主な内容を記述したヘッダー コメント ブロックを追加するのは、有効な方法です。
COMMENT
************************************************************
*** スクリプト名: {App_ID}{Script name}
*** パラメーター: {Detailed description}
*** 出力: {Describe parameters}
*** 作成者: {Name}, ABC Corporation, {Month YYYY}
*** 変更者: {Name}, ABC Corporation、スクリプトの目的とロジック
*** バージョン: 1.1.1 {app_ver.script_ver.defect.fix}
************************************************************
END