ファイル等命名規約

フォローする

共通命名規則

  • 接頭語としてプロジェクトを識別するためのコードを付与すること。
    • 同一MC上に複数のプロジェクトを持つサーバを運用している場合、操作ミスで本来とは異なるプロジェクトにロボットをアップロードしてしまう場合がある。その際、同一名称のファイルが存在する場合、意図せず既存のファイルを書き換えてしまい、本番稼働中の別プロジェクトのロボットへ影響をあたえてしまうため。

      例:) c999_Robotname.robot  …   c{code}_{filename}.{robot/snippet/type/xls/csv etc}

  • ファイル名は英数字で命名し、マルチバイト文字は利用しないこと。
    • MCへ格納される際に文字化けが生じるため。

 

種類別命名規則

  • Project
    • 何をするロボットプロジェクトなのかが明確な名称とすること。
  • Robot
    • (ファイル名) ロボットの実行内容や処理対象サイトが明確な名称とすること。
    • (ファイル名) 本番環境にアップしないテスト用、一時利用のロボットについてはDBG_を接頭語として付加すること。
    • (ステップ名) Assign/Convert Variable(変数の割当/変数の変換) については処理の内容が一目でわかるように以下のルールに従い、ステップ名を命名すること。
      • Init 変数名/アトリビュート名 … 初期化(0クリア、空白上書きなどの初期値設定)
      • Set 変数名/アトリビュート名 … 初期化後の値の挿入
      • Update 変数名/アトリビュート名 …  既に値が入っている変数/アトリビュートに対する値の上書き更新・追記
  • Type(タイプ)
    • (ファイル名) 格納するデータが明確な名称とすること。
    • (変数名) ロボットのパラメータとなるアトリビュートにはin_を接頭語として付加すること。
    • (変数名) ロボットの出力情報となるアトリビュートにはout_を接頭語として付加すること。
    • (アトリビュート名) simple type ・・・ 小文字から始まる名称とすること。
    • (変数名) complex type ・・・ 大文字から始まる名称とすること。
  • Snippet(スニペット)
    • 切り出した処理の内容や役割が明確な名称とすること。
  • DB config
    • プロジェクト名称と同一の名称とすること。
  • Resources
    • 実行環境に合せた識別子を付加すること。

      例:) c999_config_linux.xlsx … Linux環境用設定ファイル

1人中1人がこの記事が役に立ったと言っています

コメント

0件のコメント

ログインしてコメントを残してください。