コメント(Comment)の使い方

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る
コメントのアイキャッチ

 

どのプログラムにおいても基本的に英語で記載していきます。
UiPathにおいても、アクティビティタイトルなどは日本語に変更できますが、基本的には英語がメインとなります。

プログラムを作成している最中は何を行っている処理か自分自身はよく理解できているのですが、後から見直すと何をやっているかよくわからない、となることが多くあります。また他人が作成したプログラムであれば尚更そういった状況になります。
そのため、一目でかつ日本語ですぐに理解できるように、ほとんどのプログラム言語ではコメントという機能が用意されています。

コメント(Comment)とは

コメントとは作成したプログラムに対して、補足事項を日本語で記載することができる機能です。
UiPath Studioにおいてもコメント機能が用意されており、アクティビティのひとつとして利用することができます。

コメントの使い方

アクティビティパネルの検索バーに「Comment」と入力することでコメントアクティビティを見つけることができます。他のアクティビティと同じようにデザイナーパネルへドラッグアンドドロップにより配置できます。他のアクティビティと異なる点としては、コメントはあくまで作成したプログラムの内容を説明する機能であるため、ロボットで実行してもコメント部は何も実行されません。

プロパティ

DisplayName:アクティビティの表示名
Text:コメントの内容

コメントアウトとの違い

UiPathにはコメントと似たアクティビティでコメントアウト(Comment Out)が用意されています。コメントは作成したシーケンスやフローチャートに対して補足説明を行うものですが、コメントアウトは作成したアクティビティを実行しないようにすることができる機能です。UiPathにおけるコメントアウトの詳細についてはコメントアウトとはを参照ください。

コメントの効果的な使い方

コメントには折りたたんだり、非表示にしたりする機能はありません。またアクティビティとして表示されますので、一定の画面幅を必要とします。
そのためアクティビティ毎にコメントを表示したりすることは、画面幅の都合上あまりお勧めできません。

シーケンスやフローチャートの最初にコメントを配置し、この処理全体は何を行う処理なのか等を記載することに適しています。
各アクティビティごとにコメントをつける場合は、別に用意されているAnnotation(注釈)機能を使うようにしましょう。

使用サンプル

シーケンスの最初にコメントを配置し、詳細内容を追わなくても全体像を理解できるようにする。

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る

SNSでもご購読できます。

コメントを残す

*