記事

テストへのコメントの追加

テストに関する有用な情報を提供するためにコメントを追加します。

概観

コードにコメントを追加すると、以下のような場合に便利です。

テストコードも同様で、説明的なコードコメントの恩恵を受けることができますが、テストの問題は、継続的統合 (CI) インターフェイスやログファイルなど、テストのソースコードが利用できない場所に表示されることがよくあります。

これらのコンテキストでテストに関連するコメントを確認することで、問題をより迅速に診断するのに役立ちます。テスト宣言にコメントを追加すると、問題が記録された際にテストライブラリが自動的にコメントをキャプチャして表示します。

テストにコードコメントを追加する

テストまたはスイートにコメントを含めるには、@Test または @Suite 属性の直前に通常の Swift コードコメントを記述します。

// Assumes the standard lunch menu includes a taco
@Test func lunchMenu() {
  let foodTruck = FoodTruck(
    menu: .lunch,
    ingredients: [.tortillas, .cheese]
  )
  #expect(foodTruck.menu.contains { $0 is Taco })
}

// Assumes the standard lunch menu includes a taco というコメントがテストに追加されています。

以下の言語コメントスタイルがサポートされています。

コメントの書式

ソースコードコメントから自動的に追加されるテストコメントは、// や /** などの接頭辞を含め、元の書式が保持されます。これは、コメント内の空白や書式が、状況によっては意味を持ち、コメントの理解を助ける場合があるためです。例えば、コメントにサンプルコードスニペットや図が含まれている場合などです。

テストコメントを効果的に使用する

通常のコードと同様に、テストのコメントは以下のような場合に最も役立ちます。

テストがバグや問題に関連している場合は、コメントではなく Bug 特性を使用することを検討してください。詳細については、バグとテストの関連付け をご覧ください。

以下も見よ

テストの注釈付け

テストへのタグの追加

タグを使用して、整理、フィルタリング、外観のカスタマイズのための意味情報を提供します。

バグとテストの関連付け

テストによって発見または検証されたバグを関連付けます。

バグ ID (識別子) の解釈

テストライブラリが開発者によって提供されたバグ ID をどのように解釈するかを調べます。

macro Tag()

テスト関数またはテストスイートに適用できるタグを宣言します。

static func bug(String, Comment?) -> Self

テストで追跡するバグを構築します。

static func bug(String?, id: String, Comment?) -> Self

テストで追跡するバグを構築します。

static func bug(String?, id: some Numeric, Comment?) -> Self

テストで追跡するバグを構築します。