不要讓註解隱藏在原始碼中!閱讀、搜尋並使用 Live Documenter 發布它。 .NET 文件變得簡單。
Live Documenter 是一套應用程式和函式庫,支援從 .NET 程式碼和 xml 註解檔案即時檢視和自動產生文件。從我們的主頁了解 Live Documenter 是什麼並下載最新版本。
查看即時且最新的文件!
建立漂亮的靜態文檔。
或使用 API 庫整合到您自己的專案中。
Live Documenter 是一個桌面應用程式、控制台實用程式和 API 程式庫,旨在使您的 .NET 程式碼和註解更具可讀性和可用性。讓它們擺脫原始碼中 xml 的限制,充分利用它們!
首先下載最新版本並閱讀快速入門指南。
桌面應用程式允許開啟 Visual Studio 專案、解決方案或程式庫,並從即時 XML 註釋檔案中為其產生文件。如果對程式碼庫進行更改,這些更改將在重新建置專案時反映在應用程式中。
它還提供了一個用於導出文件、閱讀和列印的良好介面。
導出器應用程式對於將文件生成整合到現有流程中非常有用;例如您的建置腳本或建立臨時文件。
可供項目引用以在執行時自動產生文件的 DLL。 API 的詳細資訊以及如何使用它可以在文件中找到。
目前,這僅適用於 Windows,正在努力轉移到 netstandard 並使除桌面應用程式之外的所有內容在 .NET Core 上跨平台。
提供了最新版本的 zip 檔案。要安裝,請下載文件,解壓縮並從目錄中執行。
要求
.NET 核心 SDK 3.1
最新程式碼已在 Visual Studio 2019 中完成,其中幾個專案已轉移到 netstandard 庫並使用最新的 csproj 檔案格式。
如果從原始碼建置有任何問題,請告訴我,以便我可以解決它們。
感謝所有幫助。有一個始終可以改進的相關文件網站。
如果您想參與該項目,請查看當前的問題。記下您的興趣,獲取最新版本,並在準備合併變更時建立拉取請求。
此外,簡單地透過 GitHub 問題提供回饋有助於確保專案變得更加穩定並不斷增強。