Различия

Показаны различия между двумя версиями страницы.

--- study:spring2013:smcpp [2013/04/08 13:04]
nina
+++ study:spring2013:smcpp [2013/05/16 00:27]
nina
@@ Строка 26: / Строка 26: @@
 {{study:spring2009:classesofprogram.pdf|Кое-что о структуре классов для программы}}
-==== Д/з ====
-. {{study:spring2009:string1.zip|String}} - прототипы функций для реализации (чтобы не набирать).
+==== Подготовка документации для созданной системы классов ====
+В любом случае, надо начинать с того, что заголовочные файлы должны быть
+снабжены комментариями. Если пользоваться системой автоматической генерации документации
+(стандартно -  http://en.wikipedia.org/wiki/Doxygen), то для этих комментариев
+есть стандарт.
+Комментировать надо сам класс (его предназначение) и его содержание. Функции типа Get и Set
+можно не комментировать, если из их названия понятно, с каким полем они связаны.
+Вообще, документация должна состоять из след. частей:
+  - Общее описание - зачем это все сделано, для чего предназначено и пр.
+  - Структура (иерархия) классов.
+  - Описание каждого класса - например, просто копии заголовочных файлов, которые уже задокументированы.
+  - Пример использования (в функции main с комментариями, должно компилироваться).
+Если делать вручную, то можно просто сформировать WORD-файл, скопировав туда заголовочные файлы для классов
+и добавив общую часть и примеры. Документацию надо делать только для своих классов - распределение, выборка, хи-квадрат и пр.
+==== Д/з ====
+. {{study:spring2009:string1.zip|String}} - прототипы функций для реализации (чтобы не набирать).
 ==== Уроки по Visual C++ ====
@@ Строка 63: / Строка 80: @@
   - [[http://www.latexeditor.org/|LEd]] (free)
   - [[http://www.xm1math.net/texmaker/|TexMaker]] (free) - кросс-платформенный
@@ Строка 68: / Строка 86: @@
 ==== Статистика ====
-{{study:spring2013:smcpp:q2stat2013.pdf|Предварительный список вопросов этого года}}
+{{study:spring2013:smcpp:q2stat2013new.pdf|Cписок вопросов этого года}}
 {{study:spring2009:mouse_binom.xls|Файл для проверки гипотезы о мышке и морковке}}

study/spring2013/smcpp.txt · Последнее изменение: 2013/05/16 00:27 — nina

Наверх