コード分析ルール
- 更新日 2023/12/06
コード分析ルール
ルールはコード分析の基礎となるものです。ルールは オートメーション (タスク Bot および API タスク) ロジックの評価に使用されます。ルールには、実行される評価に応じて、単純なものや複雑なものがあります。ルールには、検証可能なコーディング プラクティスが含まれます。ルールは、オートメーション コード内のパッケージやアクションに適用されます。
ルールは、一意の RULE_CODE と、そのコードに対して行われる評価の特性を示す記述で構成されています。重大度レベル (低または高) を使用して、ルールの重要性を強調することができます。
次の表は、コード分析で使用できるルールとその説明の一覧です。
ルール コード | グループ | タイトル | ルールの説明 | オートメーション ファイルに適用 |
---|---|---|---|---|
ACT-GEN-001 | アクション、一般 | 最大アクション | Bot のアクションの数は、指定された最大値を超えることはできません。 | タスク Bot、API タスク |
ACT-GEN-002 | アクション、一般 | 試行/キャッチ欄 | Bot ロジック内のコメント以外のアクションはすべて [試行/キャッチ] ブロック内にある必要があります。 | タスク Bot、API タスク |
ACT-GEN-003 | アクション、一般 | 無限ループ検出 | Bot ロジック内の無限ループのチェックを義務付けています。 | タスク Bot、API タスク |
VAR-NMG-001 | 変数、命名 | 変数名パターン | 変数名は指定された命名パターンに一致する必要があります | タスク Bot、API タスク |
VAR-NMG-002 | 変数、命名 | 変数名の長さ | 変数名は指定された最小文字数以上で最大文字数以下にする必要があります | タスク Bot、API タスク |
VAR-USG-001 | 変数、使用状況 | 未使用の変数はありません | すべての変数は Bot 内で使用する必要があります | タスク Bot、API タスク |
ACT-COM-001 | アクション、コメント | 必須のヘッダー コメント | Bot の最初のアクションは、コメント アクションである必要があります。 | タスク Bot、API タスク |
ACT-COM-002 | アクション、コメント | コメント欄 | コメント アクションの数は、コマンド アクションの総数の指定された割合以上になる必要があります。 | タスク Bot、API タスク |
VAL-HCV-002 | 値、ハードコードされた値 | ハードコードされた遅延なし | [遅延] アクションの遅延時間は、変数を使用して設定します | タスク Bot、API タスク |
VAL-HCV-003 | 値、ハードコードされた値 | ハードコードされたファイル パスなし | ファイルまたはフォルダーのパスは、変数を使用して設定します | タスク Bot |
VAL-HCV-004 | 値、ハードコードされた値 | ハードコードされた E メール アドレスなし | コマンド アクション フィールドには、ハードコードされた E メール アドレスを含めないでください | タスク Bot、API タスク |
ACT-ERR-001 | アクション、エラー処理 | 空のキャッチなし | キャッチ ブロックを空にすることはできません | タスク Bot、API タスク |
ACT-ERR-002 | アクション、エラー処理 | 必須のキャッチ ログ | キャッチ ブロックには [ファイルに記録] アクションを含める必要があります | タスク Bot、API タスク |
ACT-ERR-003 | アクション、エラー処理 | 必須のキャッチ画面キャプチャ | キャッチ ブロックには、[画面キャプチャ ] アクションを含める必要があります | タスク Bot |
ACT-ERR-004 | アクション、エラー処理 | 必須のキャッチ行参照 | キャッチ ブロック エラーには、参照行番号を含める必要があります。 | タスク Bot、API タスク |
ACT-LOG-001 | アクション、ログ | [ファイルに記録] 欄 | Bot ロジックには、指定した割合で [ファイルに記録] アクションを含める必要があります。 | タスク Bot |