コードレビュー時のコメント機能をリリースしました!

はじめに

こんにちは!株式会社ハイヤールーの伊藤(@icchy_san)です。

本記事では、既存のアルゴリズム形式の評価時に利用できるコメント機能を追加しましたので、ご紹介させていただきます。

アルゴリズム形式の問題については、以前別のブログ記事にて記載しているのでそちらをご覧ください。

コメント機能とは

f:id:icchy-3:20210517150203g:plain
図1. コメント機能の概要

概要

提出されたソースコード内の文字(1文字以上選択された部分)ごとにコメントをつけることができる機能です(図1)。Google Docsにつけるコメントをイメージしてもらえるとわかりやすいと思います。

他の人がつけたコメントに対する返信も可能となっているので、その場でディスカッションをすることも可能となっています。

※現状(2021/05/16現在)アルゴリズム形式の問題で利用することができる機能ですが、随時別の問題形式にも対応予定です。

背景

コメント機能を作成した背景としては、導入企業様から「社内で候補者の方が提出したコードを評価した結果をもとに技術面談を行うことが多く、その際に利用しやすい機能が欲しい」、「誰か一人が評価完了すると他の人が評価できない」、「決まった評価項目だけではなく、GitHubのPRのように1行ごとにコメントできるといいかも?」などといったご要望を頂いた上で、社内で検討し開発に至りました。

ユースケース

社内エンジニア同士による評価時のディスカッションの手段として利用

評価の際に、範囲選択した部分ごとに自由にコメントができるため、評価者が確認したい部分にコメントを残し、そのコメントに対する返信という形で、ディスカッションを行うことができます。

例えば、プレイバック機能を使いながらどのように問題を解いていったのかを見ていくなかでコーディングの傾向を話し合ったり、解答コードを見て「ここはコピペっぽい挙動してるので、要確認です」や、「ここでMap使ってるのいいですね」などのコメントを残すと、そこに対して別の人が返信コメントを残すことができます。

そのようにディスカッションを進めていくことで、次のプロセスに進めるべきかどうかの決め手の一つとして利用できます。

候補者の方との技術面談の情報として利用

前述した通り社内エンジニア同士の評価時のディスカッションの結果がコメントとして残っているため、その情報を技術面談で利用することができます。

例えば、コピペっぽい挙動に対するコメントがディスカッション時につけられた場合、その内容を面談で候補者の方に深掘りをして理解度を確認し、その結果をコメントの返信という形で共有することもできます。

機能紹介

今回追加したコメント機能でできることについて順に説明します。

行、列を選択しコメントをつける

f:id:icchy-3:20210517145722g:plain
図2. コメントを作成する挙動

範囲選択した部分にコメントをつけることができます。

例えば、変数名(命名など)に関してコメントをしたとします。作成されたコメントをクリックすると対象の範囲がハイライトされます(図2)。従来であれば「○○という変数名がちょっと分かりづらかった」といった評価をしていた部分も、コメントの対象を範囲選択することで、「ここの変数名のことなんだ」と判断することができるようになりました。

どのコードに対するコメントなのか判断できないと、その際も無駄な確認コストがかかり本質ではないところに時間を使ってしまう可能性があります。

この機能によってディスカッション時には本当に確認したいことだけに絞ることができるようになりました。

また、コメントはMarkdownに対応しているため、エンジニアに馴染みのある形式で記述することができます。

コメントに対する返信

f:id:icchy-3:20210517145827g:plain
図3. コメントに対する返信の挙動

f:id:icchy-3:20210517150035p:plain
図4. 返信と返信ではないコメントの表示

図3をもとに説明すると、「これコピペっぽいですね」というコメントに対して別の評価者が賛同するといったように、コメントに対する返信を行うことができます。

また、図4のように「返信」と「返信ではない」コメントに関してはブロックを分離しているので、すぐに見分けることができます。

このように、返信機能があることでスムーズなディスカッションができるようになります。

ゆくゆくはコメントの中でメンションをつけ、通知を飛ばすような機能だったり、プレイバックの秒数を切り取った位置にコメントもできるようにする予定です。

まとめ

いかがだったでしょうか。

本記事では、今回リリースしたコメント機能について紹介してきました。

コーディング試験後の評価の際に、他の社内の人とコード評価をすることが可能となり、ますます評価時のディスカッションがしやすくなったのではないでしょうか。

このように今後も導入企業様からのご要望をもとに継続改善をしていくとともに、更なる使いやすさを求め、日々開発していきますのでよろしくお願いします。

弊社ではそういった企業様が抱える課題を解決していく仲間を求めています!

ご興味がありましたら、僕のTwitterやWantedlyの採用ページからご応募ください!

また、コーディング試験の導入をお考えの企業様がいらっしゃいましたら、ぜひ弊社LPからお問い合わせください!