開發者手冊

我和我的團隊正處於軟件開發項目的最後階段。我們正在使用visual studio編譯我們的項目和編碼在c＃中，我們需要建立用戶手冊是否有任何方法從應用程序的註釋和代碼生成用戶手冊開發者手冊

2011-09-25 uvChetty

用戶是最終用戶還是開發人員？（你正在編寫一個庫或一個GUI？） – SLaks

如果你認爲你的用戶需要知道你的代碼內部發生了什麼，那麼我真的希望你的用戶：永遠不需要閱讀手冊（如果他們這樣做，上帝保佑），或者，有權訪問源代碼和5年編程經驗。 – thomasfedb

假設您已經適當地評論了您的代碼，您可以使用許多第三方工具來生成文檔。

以下清單並非詳盡無遺：

我只希望你的最終用戶是開發人員，而你正在編寫某種API。這些文檔生成工具通常只適用於內部使用或爲您創建可供其使用的API的外部開發人員。

2011-09-25 14:17:13

感謝實際上意味着開發人員手冊，您的鏈接非常有幫助:) – uvChetty

如果您的目標受衆是其他開發人員，您可以執行類似this SO post中提到的操作，但如果最終用戶不是開發人員，那麼代碼中的註釋不太可能對他們有用，如果他們是。那麼他們可能不會對開發人員有用。

2011-09-25 14:12:39 itsmatt

回答