今日のソフトウェア開発環境では、プロジェクトの成功を保証するために、明確で徹底的なドキュメントが重要です。 DocFX C# と IronPDF は、ドキュメントを生成し、プロジェクトドキュメントの可読性とアクセス性を向上させながら、ドキュメント ワークフローを合理化する効果的な 2 つのツールです。 この投稿では、PDF ドキュメントを作成するための C# ライブラリである IronPDF を、API リファレンス ドキュメントを生成する API ドキュメント ジェネレータである DocFX と組み合わせる方法を説明します。 開発者は、これらのツールを使用して優れたドキュメントを迅速に作成し、PDF 形式で共有できます。

DocFX の使用方法

1. .NET SDK 6.0+ をインストールします
2. PowerShell を開きます。
3. DocFX ライブラリをインストールするためにスクリプトを一つずつ実行します。
4. インストール後、JSON ファイルを実行します。
5. これにより、ポート 8080 でドキュメント サイトが開きます。

DocFX イントロダクション

DocFX は、Microsoft によって作成されたオープンソースの静的サイトジェネレータおよびドキュメンテーション生成ツールです。 Markdown ファイルとソース コードを使用して、開発者はプロフェッショナルな外観のドキュメント Web サイトを作成できます。 DocFX は多くのマークアップ形式とプログラミング言語をサポートしており、さまざまなプロジェクトでの適用が可能であり、柔軟性が高いです。

開発者は DocFX を使用して、自分のドキュメントにチュートリアル、概念的な記事、および API リファレンスを作成することができます。 その柔軟なアーキテクチャにより、チームは自分たちの特定の要件に合わせてカスタマイズおよび拡張できます。 DocFX はクロスリファレンス、編集可能なテンプレート、および HTML や Markdown など多くの出力形式をサポートする機能も提供しています。 DocFX の内部機能と方法についての詳細な説明は、DocFX ドキュメンテーション をご覧ください。

DocFX の始め方

DocFX のセットアップ

DocFX を使用するのは非常に簡単です。 Microsoft の .NET パッケージ マネージャー NuGet を使用して DocFX SDK を追加することを含みます。 DocFX を使用してアプリケーションに Web コンテンツを組み込むために必要なライブラリとツールがこの SDK に含まれています。

DocFX 新しい Web サイトの作成

この段階では、ローカル コンピューター上で基本的なドキュメント Web サイトを作成します。

• コマンドライン操作の基本的な理解が必要です。
• .NET SDK 6.0 以降のバージョンが必要です。

DocFX の最新バージョンをインストールするには、.NET SDK がインストールされていることを確認し、次にターミナル コマンド ライン ツールを開いて次のコマンドを入力します。

dotnet tool update -g docfx

新しいドックセットを開始するには、以下を実行します。

docfx init

docfx init

全ての設定の JSON ファイルを作成します。 このコマンドを使用すると、現在の作業ディレクトリに新しい DocFX プロジェクトを作成できます。 ドックセットを作成するには、以下を実行します。

docfx docfx.json --serve

docfx docfx.json --serve

ウェブページはhttp://localhost:8080でプレビューできます。

変更を保存します。 DocFX は JSON 設定ファイルで設定されます。今、新しいターミナルを使用してこのコマンドを実行して、Web サイトを再構築し、ローカルの変更をプレビューします。

docfx docfx.json

docfx docfx.json

DocFX の機能

柔軟で拡張可能

DocFX は、JSON ファイル、YAML、Markdown などのマークアップ形式およびプログラミング言語に対応しています。 この柔軟性により、チームは自分たちの要件と好みに最も適した形式を選択できます。 さらに、DocFX の拡張可能なアーキテクチャにより、プログラマーはプラグインやテンプレートを通じてその機能を追加および修正し、さまざまなドキュメントのニーズに対応できます。

API ドキュメンテーション ジェネレーション

DocFX は、ソースコード内のコメントから API ドキュメントを作成する優れたツールです。 DocFX はコードのコメントを XML や YAML などの広く使用される形式で解析し、名前空間、クラス、メソッド、パラメータ、および戻り値の型を含む API リファレンス ドキュメントを自動的に作成します。 この機能により、開発者はコード API のドキュメンテーション プロセスを合理化し、多くの時間と労力を節約できます。

クロスプラットフォーム互換性

DocFX はクロスプラットフォームであり、Linux、macOS、および Windows システムで操作できます。 このクロスプラットフォーム互換性により、開発チームが使用するオペレーティング システムに関係なく、ドキュメンテーション生成をさまざまな開発ワークフローおよび設定に簡単に組み込むことができます。

組み込みの検索とナビゲーション

DocFX には、生成されたドキュメント内でのナビゲーションと検索をサポートする機能が組み込まれています。 ユーザーはトピック、API、またはキーワードを容易に検索できるので、関連情報への迅速なアクセスが可能です。 さらに DocFX は、ユーザーがドキュメント階層をより簡単に参照できる目次 (TOC) も生成し、ユーザー ビリティとエクスペリエンスをさらに高めます。

DocFX と IronPDF の統合

DocFX と IronPDF を組み合わせることで、開発者は各ツールの利点を最大限に活用し、ドキュメンテーション プロセスを向上させることができます。 開発者は、DocFX によって生成された HTML ドキュメンテーションを PDF 形式に変換するために IronPDF を活用することで、デバイス間で一貫したレンダリングを保証し、オフライン対応のドキュメントを作成し、共有および配布を容易にできます。 IronPDF の詳細については、IronPDF ドキュメンテーション をご参照ください。

IronPDFのインストール

• Visual Studio プロジェクトを開始します。
• "ツール">"NuGet パッケージ マネージャー">"パッケージ マネージャー コンソール"を選択します。
• Visual Studio パッケージ マネージャー コンソールで、次のコマンドを入力します (この行を適切なパッケージ インストール コマンドに修正してください):

Install-Package IronPdf

• または、ソリューションの NuGet パッケージマネージャーを使用して IronPDF をインストールできます。

• 検索結果で IronPDF パッケージを選択し、"インストール"オプションをクリックします。 Visual Studio がダウンロードとインストールを代行します。

  

• NuGet は、プロジェクトに必要な依存関係と共に IronPDF パッケージをインストールします。

• インストール後、プロジェクトで IronPDF を利用できます。

NuGetウェブサイトからのインストール

IronPDF の機能、互換性、および入手可能なダウンロードに関する追加情報については、NuGet ウェブサイトの NuGet パッケージ ページをご覧ください。

DLLを利用したインストール

または、DLL ファイルを利用してプロジェクトに IronPDF を直接統合できます。DLL を含む ZIP ファイルをダウンロードするには、こちらの DLL ダウンロードページ をクリックします。 ファイルを解凍してプロジェクトに DLL を追加してください。

ロジックを実装する

統合プロセスには以下のロジックが含まれます:

1. DocFX でドキュメントを作成: 始めるには、DocFX を利用してドキュメンテーションを作成します。 プロジェクトのソースコードと Markdown ファイルで DocFX のビルド プロセスを実行して HTML ドキュメントを生成します。
2. IronPDF を使用して HTML ドキュメントを PDF に変換: HTML ドキュメントが作成された後、IronPDF を使用してプログラムで PDF 形式に変換します。 HTML テキストを印刷可能な PDF ドキュメントに変換するのは、IronPDF の HTML から PDF への変換機能を使用することで簡単に行えます。
3. 変換プロセスの自動化: ワークフローを最適化するために、C# コードまたはスクリプトを使用して変換プロセスを自動化します。 これにより、手作業の介入が必要ない場合にドキュメントが簡単に更新および再生成されることが保証されます。

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

using IronPdf;

class Program
{
    static void Main()
    {
        // Create a new HtmlToPdf Renderer
        var Renderer = new HtmlToPdf();

        // Render the webpage as PDF
        var PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html");

        // Save PDF to a file
        PDF.SaveAs("output.pdf");

        // Inform the user of successful PDF creation
        Console.WriteLine("PDF generated successfully!");
        Console.ReadKey();
    }
}

Imports IronPdf

Friend Class Program
	Shared Sub Main()
		' Create a new HtmlToPdf Renderer
		Dim Renderer = New HtmlToPdf()

		' Render the webpage as PDF
		Dim PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html")

		' Save PDF to a file
		PDF.SaveAs("output.pdf")

		' Inform the user of successful PDF creation
		Console.WriteLine("PDF generated successfully!")
		Console.ReadKey()
	End Sub
End Class

Imports IronPdf

Friend Class Program
	Shared Sub Main()
		' Create a new HtmlToPdf Renderer
		Dim Renderer = New HtmlToPdf()

		' Render the webpage as PDF
		Dim PDF = Renderer.RenderUrlAsPdf("http://localhost:8080/index.html")

		' Save PDF to a file
		PDF.SaveAs("output.pdf")

		' Inform the user of successful PDF creation
		Console.WriteLine("PDF generated successfully!")
		Console.ReadKey()
	End Sub
End Class

コード例についての詳細を読むには、この 使用ガイド例 を参照してください。 実行結果は以下に示されています:

結論

最後に、C# において DocFX を IronPDF と統合することで、開発者は PDF 形式の優れたドキュメントを作成および配布するための強力なオプションを得られます。 開発者は、ドキュメンテーション生成のために DocFX と IronPDF の PDF 生成機能を組み合わせることにより、容易にアクセス可能で共有されやすい、オフライン対応の包括的なドキュメンテーションを作成できます。 この統合により、ドキュメント ワークフローが強化され、プロジェクトドキュメンテーションの可読性とアクセス性が向上し、ソフトウェア プロジェクトの成功の可能性が高まります。

この記事の推奨事項を実装し、DocFX と IronPDF の機能を活用することにより、開発者はドキュメンテーション手続きを最適化し、チームワークとコミュニケーションを改善し、ユーザーや利害関係者のためにさらに良いドキュメンテーション エクスペリエンスを提供できます。

$999 Liteバンドルには永続ライセンス、1年間のソフトウェアメンテナンス、およびライブラリのアップグレードが含まれます。 IronPDF は、再配布および期間に制限のある無料のライセンスを提供しています。ユーザーは、試用期間中にウィーターマークを視認せずにソリューションを評価できます。 価格とライセンスの詳細については、IronPDF のライセンスの詳細をご覧ください。