コメント

コメントは、Swarmの主要なフィードバックメカニズムです。 軽量なレビューワークフローの場合、レビューコメントに「タスク」としてフラグを設定することができます。これにより、作成者とレビュー担当者は、レビューのフィードバックに優先順位を付けることができます。詳細については、「タスク」を参照してください。 コメント通知は、デフォルトで遅延されます。この遅延により、レビュー作業中にコメントの追加や編集を行うための時間を確保することができます。レビューの作業中に、各コメントの通知が送信されることはありません。 複数のコメント通知が1つの通知にまとめられます。この通知は、そのまま自動的に送信することも、手動で送信することもできます。詳細については、「コメント通知の遅延」を参照してください。

コメントに「いいね」を付けたり、リンクを追加したり、ファイルを添付したり、絵文字を追加したりすることもできます。詳細については、「コメント機能」を参照してください。

以下の項目にコメントを追加することができます。

• チェンジリスト、レビュー、ジョブ
• チェンジリストの説明、レビューの説明
• チェンジリスト内のテキストファイルの行、レビュー内のテキストファイルの行
• チェンジリスト内のファイル、レビュー内のファイル

チェンジリスト、レビュー、ジョブのコメントにアクセスするには、[コメント]タブをクリックします。 作業状態(未アーカイブ)のコメントの数がタブに表示されます。 コメントの件数にマウスポインタを置くと、アーカイブされたコメントの件数を示すツールチップが表示されます。 詳細については、「コメントをアーカイブする」を参照してください。

コメントを追加する

このセクションでは、コメントの追加方法について説明します。

コメントに関する機能として、以下の機能が用意されています。

• コメント通知の遅延
• コメントへの返信
• 絵文字
• リンク
• 添付ファイル
• Markdown

チェンジリスト、レビュー、ジョブにコメントを追加する

1. チェンジリストページ、レビューページ、またはジョブページで[コメント]をクリックして、[コメント]タブを表示します。
2. テキスト領域にコメントを入力します。
3. [投稿]をクリックします。

チェンジリストまたはレビューの説明にコメントを追加する

1. チェンジリストページまたはレビューページの説明領域で、[コメントの追加]または[X件のコメント] (「X」は、既に追加されているコメントの件数)をクリックします。
2. テキスト領域にコメントを入力します。
3. [投稿]をクリックします。
ヒント

説明コメントを非表示にするには、[X件のコメント] (「X」は、すでに追加されているコメントの件数)をクリックします。 コメントをもう一度表示するには、[X件のコメント]をクリックします。

チェンジリストまたはレビューのファイル内の特定の行にコメントを追加する

1. チェンジリストページまたはレビューページで[ファイル]をクリックして、[ファイル]タブを表示します。
2. コメントを追加する行をクリックします。
3. テキスト領域にコメントを入力します。
4. [投稿]をクリックします。

チェンジリストまたはレビュー内のファイルにコメントを追加する

1. チェンジリストページまたはレビューページで[ファイル]をクリックして、[ファイル]タブを表示します。
2. 複数のファイルがある場合は、コメントを付けるファイルをクリックしてそのファイルのビューを展開します。
3. ファイルのフッターに表示されている[コメントを追加]リンクをクリックします。
4. テキスト領域にコメントを入力します。
5. [投稿]をクリックします。

コメントを編集する

このセクションでは、コメントの編集方法について説明します。

コメントに関する機能として、以下の機能が用意されています。

• コメント通知の遅延
• コメントへの返信
• 絵文字
• リンク
• 添付ファイル
• Markdown

1. コメントの[編集]リンクをクリックします。

2. 新しい添付ファイルを追加したり、既存の添付ファイルを削除したりして、コメントの内容を編集します。

   添付ファイルを削除すると、その添付ファイルに削除マークが付き、添付ファイルの緑色のバーがミュート状態になり、[X]ボタンが[復元]ボタン()に変わります。

   ヒント

   ファイルをコメントに添付したままにする場合は、ファイルの右側にある[復元]ボタン()をクリックします。

   添付ファイルを削除した状態で、編集後のコメントを保存すると、添付ファイルを復元できなくなります。 ファイルをもう一度添付する場合は、コメントをもう一度編集用として開き、そのコメントにファイルを添付する必要があります。

3. [保存]をクリックして、編集後のコメントを保存します。この操作により、削除マークが付いている添付ファイルが削除されます。 コメントのタイムスタンプに(編集済み)と表示されている場合、そのコメントは編集されています。 Swarmにより、レビュー作成者とレビュー担当者を含むすべてのユーザに通知が送信されます。ただし、コメントを編集したユーザには送信されません。

タスク

軽量なレビューワークフローの場合、レビューコメントに「タスク」としてフラグを設定することができます。これにより、作成者とレビュー担当者は、レビューのフィードバックに優先順位を付けることができます。 コードレビュー上のすべてのコメントで、タスクフラグを設定することができます。これにより、コードレビューの作成者に対して、コメント内で記述されている問題を解決する必要があることや、レビューを承認する前に問題を修正する必要があることなどを示すことができます。

コメントにタスクフラグを付ける

コメントにタスクフラグを付けるには、コメントの投稿時に[タスクとしてフラグ]チェックボックスを選択するか、既存のコメントの右上に表示されている[フラグ]ボタンをクリックし、ドロップダウンメニューで[タスクとしてフラグ]を選択します。

タスクを[対応済みタスク]または[タスクではない]に設定する

コメントにタスクとしてフラグが立てられると、そのコメントは作業状態のタスクとみなされます。 赤いフラグのボタンをクリックすると、以下のオプションを示すドロップダウンメニューが表示されます。

• 対応済みタスク: 通常、レビューの作成者がこのオプションを使用します。このオプションにより、問題が修正されたことを示すことができます。
• タスクではない: 間違ってタスクフラグが設定されたコメントを修正する場合に、このオプションを使用します。

タスクを検証する、タスクを検証してアーカイブする、タスクを開く

緑色のチェックが付いたコメントは、タスクが対処されたことを示します。 緑色のフラグのボタンをクリックすると、以下のオプションを示すドロップダウンメニューが表示されます。

• タスクの検証: 通常、問題が修正されたことを確認した後で、コメントの作成者または別のレビュー担当者がこのオプションを使用します。
• 検証とアーカイブ: 問題が修正されたことを示し、コメントをアーカイブする場合に、このオプションを使用します。アーカイブされたコメントは、非表示になります。 アーカイブされたタスクは、作業状態、対応済み、検証済みであるかどうかにかかわらず、コードレビューのタスクの数には含まれません。
• タスクの再開: [対応済みタスク]としてマークされたタスクにさらに対処する必要がある場合に、このオプションを使用します。

タスクを再開する

青いダブルチェックのついたコメントは、そのタスクが検証済みであることを示します。 青いダブルチェックをクリックすると、以下のオプションを示すドロップダウンメニューが表示されます。

• タスクの再開: 検証後にさらに対応が必要になった場合や、誤って検証が行われた場合に、このオプションを使用します。

タスクリスト

タスクフラグが設定されたコメントの件数とステータスに関する要約が、コードレビューの説明の下に表示されます。 タスクとしてフラグが立てられているコメントのうち、アーカイブされたものは表示されません。

タスクリストボタン()をクリックすると、レビューに関連するすべてのタスクを一覧表示するダイアログが開きます。

[タスク]ダイアログで、レポートユーザID(タスクを作成したユーザのユーザID)やタスクのステータスを使用して、タスクをフィルタリングすることができます。

• 作業状態のタスク(対応が必要なコメント)のみを表示するには、赤いフラグのボタンをクリックします。
• 対応済みのタスク(対応済みのコメント)のみを表示するには、緑のチェックマークのボタンをクリックします。
• 検証済みタスク(対応済みかつ検証済みのコメント)のみを表示するには、青い二重チェックマークのボタンをクリックします。

特定のタスクのみを表示するには、[タスク]ダイアログでそのタスクを選択して[表示]ボタンをクリックします。 または、[タスク]ダイアログで、目的のタスクをダブルクリックすることもできます。 この操作により、[タスク]ダイアログが終了し、Swarmによってレビューの表示内容が調整され、選択したタスクがビューに表示されます。

作業状態のタスクが含まれているレビューを承認する

コメントにタスクフラグを付けることにより、レビューを承認する前に修正しなければならない問題が存在することを視覚的に確認できるようになります。詳細については、「タスクを[対応済みタスク]または[タスクではない]に設定する」を参照してください。

Swarmで、作業状態のタスクが含まれているレビューの[承認]または[承認してコミット]を選択すると、[レビューを更新]ダイアログに警告メッセージが表示されます。 この警告メッセージは、単なる通知メッセージです。作業状態のタスクに対応する場合は[キャンセル]をクリックし、レビューを承認する場合は[承認]をクリックします。 アーカイブされた作業状態タスクの場合、警告メッセージは表示されません。

コメント機能

コメント通知の遅延

コメント通知は、デフォルトで遅延されます。この遅延により、レビュー担当者は、レビュー作業中にコメントの追加や編集を行うための時間を確保することができます。レビューの作業中に、各コメントの通知が送信されることはありません。 複数のコメント通知が1つの通知としてまとめられ、レビュー担当者がこの通知を手動で送信することになります。遅延時間が経過すると、通知が自動的に送信されます。

レビュー中に、レビュー担当者がコメントの追加や編集を行うたびに、遅延時間がリセットされます。デフォルトの遅延時間は30分に設定されています。

• 複数のレビューでコメントの追加や編集を行う場合は、それぞれのレビューで異なる遅延時間が設定されることに注意してください。この遅延時間は、自分が作業を行っている当該レビューのコメントだけに適用されます。
• 自分が作業しているレビューで、別のレビュー担当者も作業を行っている場合、そのレビュー上で、それぞれのユーザに異なる遅延時間が設定されることになります。
• 遅延されたコメント通知を手動で送信する場合、対象となるレビューで作業した自分のコメントだけが通知に含まれることになります。

コメント通知を手動で即時に送信する

1. 通常の方法で、コメントの追加や編集を行います。
2. コメントボックスの右側に表示されている[投稿して通知(X)]ボタンをクリックします。
   「(X)」は、キュー内で送信を待機している遅延状態のコメント通知の件数を表しています。現在作業中のコメントは、この件数には含まれません。
ヒント
• [投稿して通知(X)]ボタンをクリックするのを忘れた場合は、レビューページの自分のアバターの下に表示されている[すべての通知を送信]ボタンをクリックすると、レビューに関するすべての通知が即時に送信されます。
• 対象となるレビュー上で操作を行ったコメントのみが、1つの通知としてまとめられます。[投稿して通知(X)]または[すべての通知を送信]をクリックすると、この通知が送信されます。

コメントに返信する

コメントに返信すると、親コメントの下に返信がスレッド形式で表示されます。これが、デフォルトの動作です。コメントスレッドの深さレベルは、デフォルトで4に設定されています。この場合、親コメントに対して、最大4レベルまで返信を表示することができます。 Swarmで設定されている最大スレッドレベルに達した場合、そのレベル以上の返信の[返信]リンクは表示されません。親コメントをアーカイブすると、その親コメントに含まれている返信もアーカイブされます。詳細については、「コメントをアーカイブする」を参照してください。

コメントに返信するには、以下の手順を実行します。

1. 返信するコメントの下に表示されている[返信]リンクをクリックします。
2. テキスト領域にコメントを入力します。
3. [投稿]をクリックします。

絵文字

Swarmのコメントでは、絵文字用のショートコードがサポートされています。コメントを保存すると、:smile:という絵文字テキストがとして表示されます。 絵文字の上にカーソルを置くと、その絵文字のショートコードを示すツールチップが表示されます。

絵文字の詳細については、「Wikipediaの絵文字」の説明を参照してください。 絵文字の一覧は、「絵文字のチートシート」で確認することができます。

コメントのリンク

コメントにURLが含まれていると、自動的にリンクになります。 リンク先が画像またはYouTube動画である場合、そのリソースがコメントの最後に表示されます。

コメントの添付ファイル

コメントには任意のファイルを添付することができます。 エラー状態のスクリーンショットや参照コードなど、コードレビューに役立つドキュメントを共有する場合は、そうしたドキュメントをファイルとしてコメントに添付すると便利です。

作業中のコメントにファイルを添付するには、以下の手順を実行します。

1. ファイルブラウザからファイルをドラッグし、コメント領域にドロップします。

1つのコメントに複数のファイルを添付することができます。ファイルを1つずつ添付することも、複数のファイルをまとめてドラッグして添付することもできます。 コメントにフォルダを添付することはできません。

2. Swarmへのアップロード処理が即時に開始され、アップロードの進行状況がコメントの下に表示されます。
• 青いプログレスバー: Swarmへのアップロードが進行中であることを表しています。
• 緑色のファイルバー: アップロードが完了したことを表しています。
3. 誤ってコメントにファイルを添付した場合は、緑色のファイルバーに表示されている[X]ボタンをクリックすると、添付ファイルを削除することができます。
4. [投稿]をクリックします。

それぞれの添付ファイルについて、ファイルの名前とサイズがコメント内に表示されます。ファイル名をクリックすると、そのファイルが表示されます。

[コメント]タブでコメントを表示すると、コメントに添付されている画像のプレビューが表示されます。

コメントに「いいね」をつける

認証済みユーザは、コメントの下に表示されているグレーのハートアイコン()をクリックすることで、コメントに「いいね」を付けることができます。

コメントに「いいね」を付けると、そのコメントの作成者に通知が送信され、ハートアイコンの色が赤に変わります()。これは、自分がそのコメントに「いいね」を付けたことを表しています。 コメントに付けられた「いいね」の数は、ハートアイコンの横に表示されます。 コメントを編集すると、そのコメントの「いいね」がすべて削除されます。

「いいね」の件数にマウスポインタを置くと、そのコメントに「いいね」を付けたすべてのユーザの名前が表示されます。

「いいね」を取り消す場合は、もう一度ハートアイコンをクリックします。

コメントコンテキスト

変更されている行で、レビューのファイルにコメントを追加すると、コメントが追加された行よりも前に位置している数行がSwarmによって記録されます。 これにより、それらの行の削除を求めるコメントをより分かりやすく伝えることができます。

変更が行われた行に関連するすべてのコメントがコンテキストの記録を持っていますが、最初のコメントにのみコンテキストが表示されます。

コメントを既読にする

コメントに既読マークを付けると、そのコメントが1行にまとめられます。これにより、画面上のスペースが広くなるため、未読のコメントを簡単に探すことができるようになります。 既読フラグの設定は、ユーザごとに個別に記憶されます。

1件のコメントだけを既読にするには、以下の手順を実行します。

1. 投稿されたコメントの右上に表示されている[コメントを既読にする]ボタン()をクリックします。
2. 画面上のスペースを確保するため、コメントが1行にまとめられます。



注意

親コメントに既読マークを付けても、子コメントが既読になることはありません。

レビュー内のすべてのコメントを既読にするには、以下の手順を実行します。

1. レビューヘッダに表示されている[すべてのコメントを既読にする]ボタンをクリックします。
2. レビュー内のすべてのコメントが1行にまとめられ、画面上のスペースが広くなります。

ヒント

[すべてのコメントを既読にする]ボタンをクリックすると、説明コメントを含むすべてのコメントが既読状態になります。

コメントを未読にする

コメントに未読マークを付けると、そのコメントが展開表示されるため、コメントの内容を確認することができます。 既読マークが付いているコメントを変更すると、Swarmによって既読フラグが自動的にクリアされるため、そのコメントが変更されていることを視覚的に確認することができます。 以下の操作を行うと、コメントが自動的に未読状態になります。

• コメントのテキストを編集する
• コメントの添付ファイルの追加や削除を行う
• コメントにタスクフラグを付ける
• タスクを再度開く
• コメントやタスクのアーカイブを解除する

1件のコメントだけを未読にするには、以下の手順を実行します。

1. コメントの右側に表示されている[コメントを未読にする]ボタン()をクリックします。
2. コメントの内容が展開表示されます。
注意

親コメントに未読マークを付けても、子コメントが未読になることはありません。

レビュー内のすべてのコメントを未読にするには、以下の手順を実行します。

1. レビューヘッダに表示されている[すべてのコメントを未読にする]ボタンをクリックします。
2. レビュー内のすべてのコメントの内容が展開表示されます。
ヒント

[すべてのコメントを未読にする]ボタンをクリックすると、説明コメントを含むすべてのコメントが展開表示されます。

コメントをアーカイブする

コードレビューが進行するにつれて、初期バージョンのファイルに追加したコメントの有用度が下がっていく場合があります。 こうしたコメントをアーカイブすると、コメントの表示画面が見やすくなり、重要度の高いコメントを簡単に探すことができるようになります。

[アーカイブ]ボタン()を使用できるのは、最上位のコメントの場合だけです。コメントに返信が投稿されている場合、それらの返信は親コメントとともにアーカイブされます。

コメントをアーカイブするには、以下の手順を実行します。

• 投稿されたコメントの右上に表示されている[アーカイブ]ボタン()をクリックします。

アーカイブされたコメントは、ビューには表示されません。レビュー内のアーカイブ済みコメントの件数は、[コメント]タブ上部の[アーカイブ済みコメント]ボタンに表示されます。

アーカイブ済みコメントの表示と非表示を切り替えるには、[アーカイブ済みコメント]ボタンをクリックします。

コメントを復元する

アーカイブされたコメントは、復元することができます。 アーカイブされたコメントに返信が含まれている場合は、その返信も復元されます。

アーカイブされたコメントを復元するには、以下の手順を実行します。

1. [コメント]タブ上部の[アーカイブ済みコメント]ボタンをクリックして、すべてのアーカイブ済みコメントを表示します。



2. 復元するコメントを探します。
3. 復元するコメントの右上に表示されている[復元]ボタン()をクリックします。