【UiPath】見やすいワークフロー作成②_注釈を入れる


#はじめに
UiPathでの開発を進めていくとワークフローの階層が深くなったり、変数にどんな値が入るか把握できなくなってきたり…
だんだんとワークフローが見づらくなってくることはありませんか？
この記事では「見やすい・わかりやすいワークフロー」を作成するためのポイントを記載していきます。
初めて開発する方にも、開発に慣れてきた方にもぜひ活用していただけたらと思います。

：環境：
Studio 2019.10.4 - 2020/02/06
Community License

「見やすい・わかりやすいワークフロー」を作成するためのポイントとして、
①では**アクティビティ表示名の変更**について紹介しました。
　⇒ [見やすいワークフロー作成①_アクティビティ表示名変更](https://qiita.com/asamin22/private/dd0442f8d69ffdc61a01)

よろしければ ぜひこちらも参考にしてみてください。

今回は「注釈」について紹介していきたいと思います。

#注釈を入れる
UiPathでは、アクティビティや変数に注釈を入れて、
アクティビティの処理内容や、その処理をしている理由などを記述することができます。
![1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/11c93728-ea11-0503-6dae-9b6a3480e78c.png)

注釈を入れることで以下のようなメリットがあります。
1．どのような操作をしているか理解しやすくなる
2．保守性が高まる

どういうことか それぞれ見ていきましょう。

##1．どのような操作をしているか理解しやすくなる
「見やすいワークフロー作成①_アクティビティ表示名変更」では
アクティビティの表示名を変更すると処理を理解しやすいということを紹介しましたが、
表示名に長い文章を書いてしまうと見切れてしまうことがあります。
それに対し、注釈は全ての文字を表示することができます。

【アクティビティ表示名】
![3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/4209e429-64f8-2728-8676-df850c4c91cf.png)

【注釈】
![2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/3cef3b95-1c03-1959-55da-1588bdac625c.png)

**アクティビティの表示名のみでは説明できない仕様を注釈に記述する**ことで、
より可読性の高いワークフローを作成することができます。

##2．保守性が高まる
注釈を活用し可読性の高いワークフローにすることにより、後からの変更がしやすくなる上に、他人が見ても理解しやすいため引継ぎもしやすくなります。

処理の最初となるアクティビティ([シーケンス]や[フローチャート])に**処理概要**や**作成者・更新日時**などを記載すると、ワークフローの管理に役立ちます。
![1 - コピー.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/7b983dd7-4ae5-6122-a036-d6cbbc221d86.png)

※誰が見ても理解しやすいように、注釈を入れる際には社内共通の記述ルールに従い記載するようにしましょう。
(注釈に限らず、プロジェクト名やアクティビティ・変数名にも社内の命名規則に則り名前を付けるようにしてください。)

では、次に注釈を入れる方法を紹介します。


##3．アクティビティに注釈を入れる方法
以下のような代入アクティビティに注釈を入れていきたいと思います。
![スクリーンショット1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/f8b37c8a-6ae3-fd6a-cbb8-8eaacdcf8243.png)

対象のアクティビティを右クリック>[注釈]>[注釈を追加]をクリックしてください。
![スクリーンショット2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/89e46d7d-71ec-323f-2c6a-b99276744126.png)

入力ボックスがアクティビティの隣に出現するので、
![スクリーンショット3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/6e534b91-577c-60f5-d1c3-ee5c868e23e4.png)

処理の説明を入力します。
![スクリーンショット4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/9bc51e56-e0d0-7583-c318-cd446821ef64.png)

注釈があるアクティビティには、右上に吹き出しマークがつきます。
![7.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/15591b28-fa94-b760-086e-30fe8a592687.jpeg)

吹き出しマークにホバーすると注釈の内容が確認できます。
![スクリーンショット5.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/c2f78465-c1a2-af53-2a20-2911e78a8fca.png)

注釈を常に表示したい場合は、注釈の右上にあるピンマークをクリックしてください。
![スクリーンショット6.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/ab0dae97-116d-8b28-4aba-0f147bdd4c8d.png)

このようにアクティビティ内に注釈が固定されます。
![8.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/960a381d-497e-bfdf-8aaa-256bef352d50.jpeg)


##4．変数に注釈を入れる方法
変数パネルから変数を選択し、右クリック>[注釈の追加]をクリックします。
![9.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/4d9792c4-4e23-ebbc-6908-a9d2a349af50.png)

入力ウィンドウに変数の説明を記載し、[OK]をクリックします。
![11.jpg](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/1b648cca-99a1-5896-a824-4cc9b7e1f40f.jpeg)

注釈は変数名の右端にある吹き出しマークにマウスをホバーすると確認できます。
![12.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/615615/7bc96ab3-dcba-a874-9efc-3e50c8b8fb08.png)


##まとめ
注釈に処理内容や注意点などを記載することで、
**1．どのような操作をしているか理解しやすくなる**
**2．保守性が高まる**
という利点があります。

ちなみに…
注釈は何行でも書けますが、書きすぎるとどれが重要なコメントなのか
わかりにくくなる可能性があります。
注釈には、処理内容や注意点を理解するために必要なコメントのみを記載するようにしてください。

自分も他人も見やすいワークフローにするために、ぜひ注釈を活用してみてください。