コメントをソースコードに隠さないでください。 Live Documenter を使用して、読んで検索し、公開します。 .NET のドキュメントが簡単になりました。
Live Documenter は、ライブ表示と .NET コードおよび XML コメント ファイルからのドキュメントの自動生成を可能にするアプリケーションとライブラリのスイートです。当社のホームページから Live Documenter について学び、最新バージョンをダウンロードしてください。
最新のドキュメントをライブでご覧ください。
美しい静的ドキュメントを作成します。
または、API ライブラリを使用して独自のプロジェクトに統合します。
Live Documenter は、.NET コードとコメントをより読みやすく、より利用しやすくするために設計されたデスクトップ アプリケーション、コンソール ユーティリティ、および API ライブラリです。ソース コード内に閉じ込められた XML の制限からこれらを解放し、有効に活用しましょう。
最新バージョンをダウンロードし、クイック スタート ガイドを読んで開始してください。
デスクトップ アプリケーションを使用すると、Visual Studio プロジェクト、ソリューション、またはライブラリを開いて、XML コメント ファイルからそれらのドキュメントをライブで生成できます。コードベースに変更が加えられた場合、プロジェクトが再ビルドされるときに変更がアプリケーションに反映されます。
また、ドキュメントのエクスポート、読み取り、印刷のための優れたインターフェイスも提供します。
エクスポータ アプリケーションは、ドキュメント生成を既存のプロセスに統合するのに役立ちます。ビルド スクリプトやアドホック ドキュメントの作成など。
実行時にドキュメントを自動的に生成するためにプロジェクトによって参照できる DLL。 API の詳細とその使用方法については、ドキュメントを参照してください。
これは現時点では Windows でのみ動作しますが、netstandard に移行し、デスクトップ アプリケーション以外のすべてを .NET Core 上のクロスプラットフォームにする作業が進行中です。
最新バージョンのzipファイルが提供されます。インストールするには、ファイルをダウンロードし、解凍してディレクトリから実行します。
要件
.NETコアSDK3.1
最新のコードは Visual Studio 2019 で開発されており、いくつかのプロジェクトは netstandard ライブラリに転送され、最新の csproj ファイル形式が使用されています。
ソースからのビルドに問題がある場合は、解決できるようにお知らせください。
ご協力をよろしくお願いいたします。関連するドキュメント サイトがあり、いつでも改善できます。
プロジェクトに参加したい場合は、現在の問題をご覧ください。関心のあることをメモし、最新バージョンを入手し、変更をマージする準備ができたらプル リクエストを作成します。
また、GitHub の問題を通じてフィードバックを提供するだけでも、プロジェクトがより安定し、継続的に強化されるようになります。