ソース リンク

ソース リンクは NuGet からの .NET アセンブリのソース コードを開発者がデバッグすることを可能にするテクノロジです。 ソース リンクは NuGet パッケージの作成時に実行され、ソース コントロール メタデータをアセンブリとパッケージの内部に埋め込みます。 パッケージをダウンロードし、Visual Studio でソース リンクを有効にした開発者は、そのソース コードにステップ インできます。 ソース リンクからは、効率的なデバッグを可能にするソース コントロール メタデータが提供されます。

ソース リンクの使用方法は、dotnet/sourcelink GitHub リポジトリにあります。

NuGet パッケージ エクスプローラーを使用すれば、ソース リンク メタデータがパッケージに正常に埋め込まれたことを確認できます。 Repository メタデータがコミット ID と共に存在すること、各ターゲットの .dll と共に .pdb ファイルが見つかることを確認します。

NuGet パッケージ エクスプローラーのソース リンク

✔️ 検討 ソース リンクを使用して、お使いのアセンブリと NuGet パッケージにソース管理のメタデータを追加する。

ヒント

デバッガー属性を型に追加することで開発者のデバッグ機能をさらに強化できます。

  • DebuggerDisplayAttribute では、デバッガーの変数ウィンドウでクラスやフィールドを表示する方法をカスタマイズできます。
  • DebuggerStepThroughAttribute では、デバッガーに対してコードのステップ インではなくステップ実行が指示されます。
  • DebuggerBrowsableAttribute では、デバッガー変数ウィンドウにメンバーを表示するかどうかが制御されます。

✔️ 検討 シンボル ファイルを発行する (*.pdb)。

デバッグのエクスペリエンスを最善にするには、ライブラリ上でシンボル ファイルを発行してソース リンクを使用する必要があります。 シンボル ファイルとシンボル パッケージの詳細については、「シンボル パッケージ」を参照してください。

✔️ 検討 決定論的ビルドを有効にする

決定論的ビルドでは、結果として得られるバイナリが指定されたソースから構築され、追跡可能性を提供することの検証を可能にします。 決定論的ビルドとそれを有効にするための手順の詳細については、決定論的ビルドに関するページを参照してください。