Skip to content

index.md

Latest commit

 

History

History
49 lines (35 loc) · 2.18 KB

index.md

File metadata and controls

49 lines (35 loc) · 2.18 KB
Raw

FolderDiffIL4DotNet Documentation

This site brings together the existing hand-written guides and an API reference generated from XML documentation comments.

Start here:

  • README: product overview and quick start
  • User Guide: setup, usage, and configuration reference
  • Developer Guide: architecture, execution flow, DI scopes, and implementation guardrails
  • Testing Guide: test strategy, local commands, and isolation rules
  • API Reference: generated type/member reference for the public surface of both FolderDiffIL4DotNet and FolderDiffIL4DotNet.Core

To refresh the generated API reference locally:

dotnet build FolderDiffIL4DotNet.sln --configuration Release
dotnet tool update --global docfx --version '2.*'
export PATH="$PATH:$HOME/.dotnet/tools"
docfx metadata docfx.json
docfx build docfx.json

The generated site is written to _site/.

FolderDiffIL4DotNet ドキュメント

このサイトは、既存の手書きガイド群と、XML ドキュメントコメントから自動生成する API リファレンスをまとめたものです。

主な入口:

  • README: 製品概要とクイックスタート
  • ユーザーガイド: 導入、使い方、設定リファレンス
  • 開発者ガイド: アーキテクチャ、実行フロー、DI スコープ、実装上の注意点
  • テストガイド: テスト戦略、ローカル実行コマンド、分離ルール
  • API リファレンス: FolderDiffIL4DotNet と FolderDiffIL4DotNet.Core の公開 API を自動生成した参照資料

ローカルで API リファレンスを更新する手順:

dotnet build FolderDiffIL4DotNet.sln --configuration Release
dotnet tool update --global docfx --version '2.*'
export PATH="$PATH:$HOME/.dotnet/tools"
docfx metadata docfx.json
docfx build docfx.json

生成されたサイトは _site/ に出力されます。