什麼是用戶文檔的例子？

Question

我正在使用C++爲我的一個cs課程編寫這個Rational數字類。我們還被要求提交一份「用戶文檔」，這是我以前從未做過的事情。什麼是用戶文檔的例子？它的格式是什麼？謝謝！

Answer 1

嘗試Doxygen。它會動態生成一些文檔。 對於一個例子，請看http://www.boost.org/doc/libs/1_40_0

Answer 2

「用戶文檔」是您將使用您的軟件給某人的書面說明。換句話說，寫一些告訴最終用戶，在這種情況下是你的老師，如何運行你的程序。

看看doxygen的方式，將您的代碼的註釋轉換爲html用戶文檔。

Answer 3

你應該問你的導師，以澄清他/她是要求 - 這就是一名優秀的工程師會做...確保與客戶:)

用戶文檔可能意味着敲定的問題：

• 源代碼文檔（用戶是另一個程序）
• README.txt文件中的HTML，CHM
• 最終用戶文檔，無論

Answer 4

把它簡單...使用這個片段的方法更換前在必要時：

//************************************************************** 
// Output condition over the program after method execution 
// Input variables, their type and meanings 
// Return value 
//************************************************************** 

您應該看到Java API注意到一個文件應該如何...