Оформление и документирование программного кода

75

Ну не так уж и часто, поэтому до недавнего времени эта фраза как-то не воспринималась всерьёз. Пока однажды не встала задача адаптировать С-код в среду MatLAB. В этой среде есть встроенный С-компилятор, так вот он не совсем адекватно реагировал на кириллицу в комментариях. Чтобы это, в конце концов, понять было затрачено много рабочего времени.

Авторы упомянутого учебного пособия работают в том же учебном заведении, что и известный автор учебников по языку С/С++ Павловская Татьяна Александровна. В учебном пособии много толковых советов по выбору стиля программирования. Мы в своей работе стремимся их придерживаться. Следовательно, для наших студентов оно обязательно для ознакомления.

Санкт-Петербургский государственный институт точной механики и оптики (бывший ЛИТМО, военмех), где работают упомянутые авторы, знаменит тем, что США вводили против него санкции. Это явный индикатор того, что работать там до недавнего времени умели, а реальная наука, видимо, ещё не окончательно умерла.

3Литература для изучения

1.Непейвода Н.Н. Скопин И.Н. Основания программирования. - Москва — Ижевск: Институт компьютерных исследований, - 2003, 868 стр. Электронная версия: _____

2.Если Вы программируете на С\С++, в основе Вашего стиля кодирования лежит? http://habrahabr.ru/post/116819/

3.Сацкий Сергей. Стандарт кодирования программ на языке C++. http://satsky.spb.ru/articles/CodingStandard/CodingStandard.php.- 2005г.

4.Степанов Е.О., Чириков С.В. Стиль программирования на С++. - 2001 – c [] www.ict.edu.ru/ft/001718//style.pdf или \\sv2\_For_Students\MPSSAU\iStyle_C\style_.pdf

5.Правила оформления исходного текста программ. - Сайт томского железнодорожного техникума URL: http://www.ttgdt.edu.ru/docs/08/recomend/text_pro.html.

6.Павловская Т.А. C/C++. Программирование на языке высокого уровня. — CПб.: Питер, 2001-2011. - 461 с.

7.Козаченко В.Ф. Эффективный метод программной реализации дискретных управляющих автоматов во встроенных системах управления // "Энергосбережение" №7/2005, - www.motorcontrol.ru/publications/state_mashine.pdf

8.Ковязин Р. Выбор технологии программирования встроенных систем // Компоненты и технологии. 2005 № 1 — с. 23

9.Парфенов В.В., Терехов А.Н. RTST - технология программирования встроенных систем реального времени //

10.Сборник статей и ссылок по теме «Автоматы» - Национальный Исследовательский Университет Информационных Технологий, Механики и Оптики, Кафедра «Технологии программирования» .http://is.ifmo.ru/progeny (дата обращения )

11.Виктор Тимофеев. Как писать программы без ошибок http://www.pic24.ru/doku.php/osa/articles/encoding_without_errors. - ноябрь. 2009г.

ТУСУР, Миландр

Каф. ЭСАУ

Недяк С.П., Шаропин Ю.Б

Весна 2013 г.