Я пишу этот класс Rational для одного из моих курсов cs, используя C++. Мы также попросили передать «пользовательскую документацию», которая является тем, что я никогда раньше не делал. Что такое пример документации пользователя? Каков его формат? Благодаря!Что такое пример документации пользователя?
Попробуйте Doxygen. Он будет динамически генерировать часть документации. Для примера см. http://www.boost.org/doc/libs/1_40_0
«Документация пользователя» - это инструкции, которые вы дадите кому-то, используя ваше программное обеспечение. Другими словами, напишите что-нибудь, что сообщает конечному пользователю, в данном случае вашему инструктору, как запустить вашу программу.
Взгляните на doxygen, чтобы вы могли превратить комментарии своего кода в документацию пользователя html.
Вы должны спросить своего инструктора, чтобы уточнить, что он/она просит - это то, что хороший инженер будет делать ... убедитесь, что прибить проблему с клиентом :)
документы Пользователь может означать :
+1 для первого предложения – mpen
Берите просто ... использовать этот фрагмент кода, прежде чем методы замены в случае необходимости:
//**************************************************************
// Output condition over the program after method execution
// Input variables, their type and meanings
// Return value
//**************************************************************
Вы должны увидеть Java API заметить, как документация должна быть ...
Вы должны дать документ. HTML? или они просят только прокомментировать исходный код? – JPCF
Я предполагаю, что это для школьного задания. Учитывая уровень сложности вашего проекта, я не думаю, что это что-то формальное. Просто прокомментируйте свой код и кратко объясните, как использовать свой класс. – 2009-11-07 03:47:00