Спец.выч.практ., 322 гр., спец. СМ

Место и время проведения: вторник 2 пара (2412) и среда 4 пара (2507)
Преподаватель: Голяндина Нина Эдуардовна

Материалы по программированию и не только¶

О большой программе¶

Общее задание

Комментарии к заданию

Примеры программы позапрошлого года

Другие примеры программы, включая программу под DOS 1998 года

Ф.р. нормального и хи-квадрат распределений и обратные к ним.

Дополнительная информация:

Как правильно работать с заголовочными файлами

Кое-что о структуре классов для программы

Подготовка документации для созданной системы классов¶

В любом случае, надо начинать с того, что заголовочные файлы должны быть снабжены комментариями. Если пользоваться системой автоматической генерации документации (стандартно - http://en.wikipedia.org/wiki/Doxygen), то для этих комментариев есть стандарт. Комментировать надо сам класс (его предназначение) и его содержание. Функции типа Get и Set можно не комментировать, если из их названия понятно, с каким полем они связаны.

Вообще, документация должна состоять из след. частей:

Общее описание - зачем это все сделано, для чего предназначено и пр.
Структура (иерархия) классов.
Описание каждого класса - например, просто копии заголовочных файлов, которые уже задокументированы.
Пример использования (в функции main с комментариями, должно компилироваться).

Если делать вручную, то можно просто сформировать WORD-файл, скопировав туда заголовочные файлы для классов и добавив общую часть и примеры. Документацию надо делать только для своих классов - распределение, выборка, хи-квадрат и пр.