Из этой статьи вы узнаете, как создать документ псевдокода для вашей компьютерной программы. Псевдокод, по сути, влечет за собой создание не связанного с программированием контура вашего кода.
Шаги
Часть 1 из 3: Понимание основ псевдокода
Шаг 1. Узнайте, что такое псевдокод
Псевдокод - это пошаговая письменная схема вашего кода, которую вы можете постепенно транскрибировать на язык программирования. Многие программисты используют его для планирования функции алгоритма перед тем, как приступить к более технической задаче кодирования.
Псевдокод служит неформальным руководством, инструментом для обдумывания программных проблем и средством общения, которое может помочь вам объяснить свои идеи другим людям.
Шаг 2. Понять, почему псевдокод полезен
Псевдокод используется, чтобы показать, как должен работать вычислительный алгоритм. Кодеры часто используют псевдокод в качестве промежуточного шага в программировании между этапом начального планирования и этапом написания реального исполняемого кода. Некоторые другие варианты использования псевдокода включают следующее:
- Описание того, как должен работать алгоритм. Псевдокод может показать, где конкретная конструкция, механизм или метод может или должен появиться в программе.
- Объяснение вычислительного процесса менее технически подготовленным пользователям. Компьютерам нужен очень строгий синтаксис ввода для запуска программы, но людям (особенно непрограммистам) может быть легче понять более гибкий, субъективный язык, который четко определяет цель каждой строки кода.
- Разработка кода в группе. Разработчики программного обеспечения высокого уровня часто включают псевдокод в свои проекты, чтобы помочь решить сложную проблему, с которой, как они видят, сталкиваются их программисты. Если вы разрабатываете программу вместе с другими кодировщиками, вы можете обнаружить, что псевдокод помогает прояснить ваши намерения.
Шаг 3. Помните, что псевдокод субъективен и нестандартен
Не существует установленного синтаксиса, который вы обязательно должны использовать для псевдокода, но это обычная профессиональная вежливость - использовать стандартные структуры псевдокода, которые другие программисты могут легко понять. Если вы сами пишете код для проекта, то самое важное - это то, что псевдокод помогает вам структурировать свои мысли и претворять в жизнь свой план.
- Если вы работаете с другими над проектом - будь то ваши коллеги, младшие программисты или нетехнические сотрудники - важно использовать хотя бы некоторые стандартные структуры, чтобы все остальные могли легко понять ваши намерения.
- Если вы записаны на курс программирования в университете, в лагере программистов или в компании, вы, скорее всего, будете проверены на соответствие «стандарту» преподаваемого псевдокода. Этот стандарт часто варьируется в зависимости от учебного заведения и учителя.
Ясность - основная цель псевдокода, и она может помочь, если вы работаете в рамках принятых соглашений о программировании. По мере того, как вы разрабатываете свой псевдокод в реальный код, вам нужно будет транскрибировать его на язык программирования, чтобы с учетом этого можно было структурировать ваш план.
Шаг 4. Сосредоточьтесь на основной цели псевдокода
После того, как вы добьетесь успеха, можно легко вернуться к написанию кода. Запоминание цели вашего псевдокода - объяснение того, что должна делать каждая строка программы - будет поддерживать вас при создании документа псевдокода.
Часть 2 из 3: Написание хорошего псевдокода
Шаг 1. Используйте текстовый редактор
Может возникнуть соблазн использовать текстовый процессор (например, Microsoft Word) или аналогичную программу для создания документа с расширенным текстом, но псевдокод требует как можно меньше форматирования, чтобы он оставался простым.
К редакторам обычного текста относятся Блокнот (Windows) и TextEdit (Mac).
Шаг 2. Начните с записи цели процесса
Выделение одной или двух строк для объяснения цели вашего кода поможет настроить остальную часть документа, а также избавит вас от задачи объяснения функции программы каждому человеку, которому вы показываете псевдокод.
Шаг 3. Напишите только одно утверждение в каждой строке
Каждый оператор в вашем псевдокоде должен выражать только одно действие для компьютера. В большинстве случаев, если список задач составлен правильно, то каждой задаче будет соответствовать одна строка псевдокода. Подумайте о том, чтобы написать свой список задач, затем перевести этот список в псевдокод, а затем постепенно развить этот псевдокод в настоящий, машиночитаемый код.
Шаг 4. Эффективно используйте пробелы и отступы
Использование пробелов между «блоками» текста поможет изолировать различные компоненты вашего псевдокода, а выделение различных частей каждого блока будет указывать на то, что эти части псевдокода попадают в раздел с меньшим отступом.
Например, раздел псевдокода, в котором обсуждается ввод числа, должен находиться в одном «блоке», тогда как следующий раздел (например, раздел, в котором обсуждаются выходные данные) должен находиться в другом блоке
Шаг 5. При необходимости используйте клавиши с большой буквы
В зависимости от требований к вашему псевдокоду или среды, в которой вы публикуете псевдокод, вам может потребоваться использовать заглавные буквы в командах, которые останутся в фактическом коде.
Например, если вы используете команды «если» и «то» в своем псевдокоде, вы можете изменить их так, чтобы они читались «ЕСЛИ» и «ТОГДА» (например, «ЕСЛИ введите число, ТОГДА выведите результат»)
Шаг 6. Пишите, используя простую терминологию
Помните, вы пишете о том, что будет делать проект, а не резюмируете сам код. Это особенно важно, если вы пишете псевдокод, чтобы служить демонстрацией для клиента, который не знает кодирования, или в качестве проекта для начинающего программиста.
Возможно, вы даже захотите полностью избавиться от любых команд кодирования и просто определить процесс каждой строки простым языком. Например, «если ввод нечетный, вывод« Y »» может стать «если пользователь вводит нечетное число, вместо этого отобразить« Y »».
Шаг 7. Держите псевдокод в правильном порядке
Хотя язык, который вы используете для изменения вашего псевдокода, должен быть простым, вам все равно нужно хранить каждую часть вашего псевдокода в том порядке, в котором он должен выполняться.
Шаг 8. Не оставляйте ничего на волю воображения
Все, что происходит в процессе, нужно полностью описывать. Утверждения псевдокода близки к простым заявлениям на английском языке. Псевдокод обычно не использует переменные, а вместо этого описывает, что программа должна делать с объектами, близкими к реальным, такими как номера счетов, имена или суммы транзакций.
Шаг 9. Используйте стандартные структуры программирования
Даже если нет стандарта для псевдокода, другим программистам будет легче понять ваши действия, если вы будете использовать структуры из существующих (последовательных) языков программирования. Используйте такие термины, как «if», «then», «while», «else» и «loop» так же, как и в предпочитаемом вами языке программирования. Рассмотрим следующие конструкции:
- if CONDITION then INSTRUCTION - это означает, что данная инструкция будет выполняться только в том случае, если данное условие истинно. «Инструкция» в данном случае означает шаг, который программа выполнит, а «условие» означает, что данные должны соответствовать определенному набору критериев, прежде чем программа выполнит действие.
- while CONDITION do INSTRUCTION - это означает, что инструкция должна повторяться снова и снова, пока условие не перестанет быть истинным.
- do INSTRUCTION while CONDITION - это очень похоже на «while CONDITION do INSTRUCTION». В первом случае условие проверяется до выполнения инструкции, но во втором случае сначала выполняется инструкция; таким образом, во втором случае ИНСТРУКЦИЯ будет проводиться хотя бы один раз.
- ИМЯ функции (АРГУМЕНТЫ): ИНСТРУКЦИЯ - это означает, что каждый раз, когда в коде используется определенное имя, это сокращение для определенной инструкции. «Аргументы» - это списки переменных, которые можно использовать для уточнения инструкции.
Шаг 10. Организуйте разделы псевдокода
Если у вас есть большие разделы псевдокода, которые определяют другие части псевдокода в том же блоке, вы можете использовать скобки или другие идентификаторы, чтобы сохранить все, что содержится.
- Скобки - как стандартные (например, [code]), так и изогнутые (например, {code}) - могут помочь содержать длинные сегменты псевдокода.
-
При кодировании вы можете добавлять комментарии, набрав "" слева от комментария (например,
// Это временный шаг.
- ). Вы можете использовать этот же метод при написании псевдокода, чтобы оставлять заметки, которые не помещаются в кодируемый текст.
Шаг 11. Еще раз проверьте свой псевдокод на удобочитаемость и ясность
К концу документа вы сможете ответить на следующие вопросы:
- Будет ли понят этот псевдокод тем, кто не знаком с процессом?
- Написан ли псевдокод таким образом, чтобы его было легко перевести на компьютерный язык?
- Описывает ли псевдокод весь процесс, ничего не упуская?
- Все ли имена объектов, используемых в псевдокоде, понятны целевой аудитории?
- Если вы обнаружите, что раздел псевдокода требует доработки или в нем явно не указан шаг, который кто-то может забыть, вернитесь и добавьте необходимую информацию.
Часть 3 из 3: Создание примера документа с псевдокодом
Шаг 1. Откройте текстовый редактор
Вы можете использовать Блокнот (Windows) или TextEdit (Mac) по умолчанию, если не хотите устанавливать новую программу.
Шаг 2. Определите вашу программу
Хотя это не является строго необходимым, написание строки из одного или двух предложений в верхней части документа с самого начала прояснит цель программы:
Эта программа запросит приветствие от пользователя. Если приветствие совпадает с конкретным ответом, ответ будет доставлен; в противном случае будет доставлен отказ.
Шаг 3. Напишите вступительную последовательность
Ваша первая команда, то есть первое, что ваша программа должна сделать при запуске, должна быть первой строкой:
распечатать приветствие "Привет, незнакомец!"
Шаг 4. Добавьте следующую строку
Поместите пробел между последней строкой и следующей, нажав ↵ Enter, затем создайте следующую строку кода. В этом примере пользователь должен запросить следующую строку диалога:
напечатать подсказку нажмите "Enter", чтобы продолжить
Шаг 5. Добавьте призыв к действию
В этом примере пользователю будет предложено ввести приветствие:
напечатайте призыв к действию "Как дела?"
Шаг 6. Покажите пользователю список ответов
Опять же, после нажатия ↵ Enter в этом примере пользователь должен увидеть список возможных ответов:
отображать возможные ответы «1. Хорошо». "2. Отлично!" «3. Не хорошо».
Шаг 7. Запросите ввод у пользователя
Здесь программа попросит пользователя ввести ответ:
распечатать запрос на ввод «Введите число, которое лучше всего вас описывает:»
Шаг 8. Создайте команды «если» для ввода пользователя
Поскольку пользователь может выбрать несколько ответов, вы захотите добавить несколько результатов в зависимости от выбранного ответа:
если "1" вывести ответ "Денди!" если "2" напечатать ответ "Фантастика!" если "3" напечатать ответ "Свети, лютик!"
Шаг 9. Добавьте сообщение об ошибке
В случае, если пользователь неправильно выберет ответ, вы можете подготовить сообщение об ошибке:
если ввод не распознается, напечатайте ответ: «Вы не очень хорошо следуете инструкциям, не так ли?»
Шаг 10. Добавьте остальные компоненты программы
Просмотрите свой документ и добавьте или конкретизируйте любые детали, чтобы убедиться, что и вы, и любой, кто читает документ, поймете его значение. В соответствии с примером этого метода ваш окончательный документ с псевдокодом должен выглядеть примерно так:
Эта программа запросит приветствие от пользователя. Если приветствие совпадает с конкретным ответом, ответ будет доставлен; в противном случае будет доставлен отказ. распечатать приветствие "Привет, незнакомец!" напечатать подсказку нажмите "Enter", чтобы продолжить
распечатать призыв к действию "Как дела?" отображать возможные ответы «1. Хорошо». "2. Отлично!" «3. Не хорошо». напечатать запрос на ввод «Введите число, которое лучше всего вас описывает:» если «1» напечатайте ответ «Денди!» если "2" напечатать ответ "Фантастика!" если "3" напечатать ответ "Свети, лютик!" если ввод не распознается, напечатайте ответ: «Вы не очень хорошо следуете инструкциям, не так ли?»
Шаг 11. Сохраните документ
Нажмите Ctrl + S (Windows) или ⌘ Command + S (Mac), введите имя и щелкните Сохранить сделать так.
