什么是用户文档的示例?

时间:2009-11-07 03:41:11

标签: c++ documentation

我正在使用C ++为我的一个cs课程编写这个Rational数字类。我们还被要求提交一份“用户文档”,这是我以前从未做过的事情。什么是用户文档的示例?它的格式是什么?谢谢!

4 个答案:

答案 0 :(得分:2)

“用户文档”是您向使用您的软件的人提供的书面说明。换句话说,写一些告诉最终用户的东西,在这种情况下是你的教师,如何运行你的程序。

看看doxygen是否可以将代码的注释转换为html用户文档。

答案 1 :(得分:1)

尝试Doxygen。它将动态生成一些文档。 有关考试,请查看http://www.boost.org/doc/libs/1_40_0

答案 2 :(得分:1)

你应该让你的导师澄清他/她的要求 - 这是一个优秀的工程师会做的......确保与客户确定问题:)

用户文档可能意味着:

  • 源代码文档(用户是另一个程序)
  • README.txt文件
  • HTML,CHM中的最终用户文档,无论

答案 3 :(得分:0)

简单地说......在必要时替换方法之前使用此代码段:

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

您应该看到Java API注意文档应该如何...