Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
UiPathの可読性を上げるコメント術
Search
こう
April 06, 2023
Programming
0
1.3k
UiPathの可読性を上げるコメント術
RPA Cummunity 2023年4月6日19時30分~
【自動化やIT活用ネタ+ChatGPT】ライトニングトーク大会~初参加者大歓迎~
登壇資料
こう
April 06, 2023
Tweet
Share
More Decks by こう
See All by こう
北海道のDX取組状況
kou12092
0
600
無償で誰でも簡単StudioX.pdf
kou12092
1
750
ロボットの実行すらメンドクサイ!?
kou12092
0
680
Other Decks in Programming
See All in Programming
Tailwind CSSを本気でカスタマイズする方法
fsubal
14
5.5k
Let's learn code review
riofujimon
2
570
if constexpr文はテンプレート世界のラムダ式である
faithandbrave
3
670
大規模UIKitベースアプリへのTCAの段階的導入/gradual-adoption-of-tca-in-a-large-scale-uikit-based-app
takehilo
2
200
Azure OpenAI Serviceのプロンプトエンジニアリング入門
tomokusaba
3
870
Goのエラースタックトレースの歴史と今後
sonatard
10
1.8k
障害対応を起点としたもっといい開発と運用のサイクル作りのためにできること / Hatena Enginner Seminar #29
polamjag
0
380
Git Rebase
bkuhlmann
11
1.6k
使ってみよう Azure AI Document Intelligence
kosmosebi
2
360
スキーマ駆動開発による品質とスピードの両立 - 私達は何故、スキーマを書くのか
kentaroutakeda
0
180
Sheets API使ってみた
toshi0383
2
160
MetricKitで予期せぬ終了を検知する話 / Detect unexpected termination with MetricKit
nekowen
1
200
Featured
See All Featured
Raft: Consensus for Rubyists
vanstee
133
6.3k
How to Ace a Technical Interview
jacobian
273
22k
Become a Pro
speakerdeck
PRO
13
4.6k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
65
14k
Pencils Down: Stop Designing & Start Developing
hursman
117
11k
Java REST API Framework Comparison - PWX 2021
mraible
PRO
18
6.9k
BBQ
matthewcrist
80
8.8k
Building Adaptive Systems
keathley
32
1.9k
Debugging Ruby Performance
tmm1
70
11k
Adopting Sorbet at Scale
ufuk
69
8.6k
Faster Mobile Websites
deanohume
300
30k
Robots, Beer and Maslow
schacon
PRO
155
7.9k
Transcript
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の技
ご清聴 ありがとうございました