簡體   English   中英

C# 的文檔工具,它不僅可以從源代碼制作文檔

[英]Documentation tool for C# which can make docs not only from source code

我不想在源代碼中放置XML注釋或任何內容。

我想做這樣的事情:

  1. 單擊添加類 - 類型名稱
  2. 單擊添加方法 - 鍵入名稱
  3. 添加描述,圖像等。

你可以這樣做,你知道編譯器支持 C# 中的 XML 注釋,輸出是這個 XML,它只是 XML。

您可以使用反射為此構建一個簡單的工具。 這是學習更多關於反射和 .NET 類型系統的很好的練習。

不過,我實際上建議反對它,因為將源代碼和文檔放在一個地方可以更容易地遵守DRY 原則 你不希望你的文檔和源代碼分開,你總是可以折疊注釋(這樣,當你編輯源代碼時它們不會出現)。 然后您的文檔也將受到源代碼控制。

Sandcastle 使 msdn 像來自 xml 代碼的幫助文件一樣好。

教程

更新

對於我誤導性的回答,我深表歉意。 你可以試試Adobe Robocop 我們用它來制作高質量的 chm 文件,即使是動畫 gif。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM