ПРАВИЛО О.Р.С.
Учили меня программированию в одна тысяча девятьсот лохматом году.Так давно,что уже и не помню когда. Но главное правило Советского программиста я помню чётко: О.Р.С.
Современные программеры обычно или забывают про него или вообще не знают.А зря.Сколько проблем снимает это правило в процессе написания и отладки програм.
Итак, что же это такое О.Р.С. и с чем его едят...
О - откат.
Р - ремарка
С - структура.
Начнем с отката. Это совсем не то,о чем вы подумали в первый момент. Денег давать никому не надо! Под откатом понимаем возвращение к исходному состоянию.Проще понять на таком примере: Вы начинаете править файлик с не вашей программой. Правили, правили и доправили до такого состояния, что и прога не работает и вы ничего не понимаете ни в проге, ни в своих исправлениях.Вот тут вам и придет на помощь золотое правило программиста:
"ПРЕЖДЕ ЧЕМ ПРАВИТЬ ПОДУМАЙ, КАК БУДЕШЬ ОТЫГРЫВАТЬ НАЗАД!"
В начале работы вам обязательно нужно создать копию исходного файла.Обычно принято, что такая копия носит точно такое же имя, но другое расширение (как правило bak).
Например:
Исходный файл: ui_hud.script
Файл копия:ui_hud.script.bak
Такой способ очень удобен. Во-первых, вы обезопасили всю программу наличием копии курочиваемого файла. Во-вторых, эти два файлика всегда лежат рядышком (если конечно отсортированно по имени)и не надо копию долго искать.В-третьих,вы всегда легко определите, какие именно файлы вы правили (по наличию копий). И в-четвертых, после отладки и тестирования вам легко убрать файловый мусор, выбрав файлы для удаления по маске "*.bak"
Кроме этого,в случаях каких-то глобальных правок, рекомендуется на всякий случай сделать копию всех файлов программы.У меня на винте в директории Сталкера всегда есть две папочки:gamedata и gamedata.bak
Теперь о ремарках или, в простонародье, комментариях. Если вы пишите свою программу с нуля, то по-началу вам легко удается все держать в голове: Все переменные, предназначения всех функций, логику построения условий и т.д. Но чем больше листинг, тем труднее это делать. Можно конечно записывать, но бумажка может потеряться. да и сложно искать в своих записях причину введения какой-нибуть 38 локальной переменной... Поэтому не пренебрегайте ремарками в листинге программы!!!!!Посмотрите для примера два файлика
player_ogg.script и ui_cheat_player.script
В этих файлах практически ничего не осталось писаного до меня. так что можно считать, что я их с нуля писал. Посмотрите сколько там ремарок. И скажу вам по секрету, что после отладки, когда я вычищал листинг от мусара, я потер процентов 70 ремарок, которые были изначально.
У ремарок есть ещё одна функция. Мой учитель по программированию неустанно повторял своим ученикам: "Листинг программы должен быть откоменнитован так, что даже самый последний идиот поймет об чем здесь идет речь!".Сегодня я написал программу, завтра придет другой програмист и начнет её переделывать. Насколько ему будет проще, если я ему все в ремарках объясню...
Есть ещё несколько правил, по правке чужой программы.
1. Всегда выделяйте ремарками начало и конец вашей правки.
2.Внутри этого выделения обязательно должен находиться заремленный исходный текст и ваш новый.
Поправили кусок прграммы, запустили - не работает. Вам очень легко восстановить исходный текст, а потом уже анализируя и постепенно вводя ваши изменения, найти причину ошибки.
И последнее. Структурность листинга. По большому счету весь скрипт можно записать одной большой строкой. И он будет работать. Но читать этот листинг совершенно невозможно.Эту цель, наверное, и приследывали (как пример) авторы биорадара.Загляните в их скрипты. там как раз одна очень длинная строка. Зачем это сделано - непонятно. Чего они скрыть хотели?
Структура позволяет вам легко читать листинги, искать ошибки в процессе отладки. Да и сам процесс создания программы упрощается значительно.
Вот в кратце и все, что касается ПРАВИЛА О.Р.С.