UiPathの可読性を上げる コメント術

自己紹介 名前：こう 住所：北海道札幌市(移住2018年～) 仕事：RPA(UiPath)は2018年～(実は最近あまり触ってない…) Salesforceは2022年～ Javaは～2017年。2023年～？ Twitter：@kou12092 Note：kou12092 Qiita：@kou1209 UiPath RPAアソシエイト UiPath RPAデベロッパー上級 Salesforce認定アソシエイト JPBA認定1級インストラクター アロマテラピー検定1級

コメント書いてますか？

コメントの使い道 • 改修の際、何をしているか思い出す • 他の人が見たときの理解を助ける 「改修は忘れた頃にやってくる」 「改修するのはあなたではないかも」

今回のお話 部品化された機能の頭紙のコメント

目指すコメントはこれ！ javadoc StringクラスのcharAtメソッド (例)"abcde".charAt(0) → 'a‘ "abcde".charAt(1) → 'b'

処理の概要を書く この部品は何を行っているかを記載。 ・処理の結果、どうなるか ・どういうルールで処理が行われるか ・特記すべきことはあるか

前提条件を書く この部品を使う際の前提条件を記載。 ・どういう状態で呼び出すべきか？ ・制約事項はあるか？

入力引数を書く この部品に渡す引数を記載。 ・データ型 ・引数名 ・引数の説明（何を渡すべきか）

出力引数を書く この部品から戻される引数を記載。 ・データ型 ・引数名 ・引数の説明（何が返されるか）

例外条件を書く この部品から明示的にスローされる例外を記載。 ・例外の型 ・どのような場合に発生するか

部品につけたコメント

まとめ 部品化したものの頭紙に以下の内容を記載 • 処理の概要 • 前提条件 • 入力引数 • 出力引数 • 明示的にスローする例外 可読性UP 中身を読まなくても部品を 使うことができる

chatGPTを絡めて 「UiPathのコメントで一句」 流れるプロセス コメント添える UiPathの技

ご清聴 ありがとうございました