Листинг программы по ГОСТ: что это и как оформить код в Word

Листинг программы — это оформленный фрагмент исходного кода, вставленный в документ для пояснения логики работы. Он может быть частью курсовой, диплома или технической документации. В статье расскажем, что такое листинг программы и как оформить листинг кода по ГОСТ, включая примеры и правила оформления в Word.

Что говорит ГОСТ и международные стандарты

• ГОСТ 19.505–79 описывает, как оформляется листинг программы и текст программного кода как документ — в составе пояснительной записки или как отдельное приложение.
• ГОСТ 19.402–78 "Описание программы" разрешает включать листинг кода в Word-документы для пояснения структуры и логики работы:
  • "Допускается приводить фрагменты текста программы для пояснения описываемых алгоритмов, структур данных, логики функционирования программных модулей." (раздел 3.4 ГОСТ 19.402–78)
• ГОСТ 2.105–95 – разрешает вставки данных и структур для объяснения технических решений.
• ГОСТ Р 7.0.97–2016 – устанавливает правила для приложений, заголовков, оформления текста.
• ISO/IEC 26514:2008 – рекомендует включать код и команды в документацию для объяснения работы системы.
• IEEE 1016–2009 – предписывает использовать код в проектной документации для пояснения архитектуры и модулей.

Что такое листинг программы

Листинг программы — это фрагмент исходного кода, конфигурации, CLI-команды или SQL-запроса, оформленный в соответствии с ГОСТ. Простыми словами, листинг кода — это пример программы, который демонстрирует, как работает алгоритм или модуль. Это может быть как функция или метод, так и шаблон настройки или сценарий выполнения.

Зачем вставлять листинг в документацию

• Прослеживаемость – фиксирует реализацию при передаче, депонировании, проверке.
• Трассировка требований → код – связывает требования с реализацией.
• Пояснение архитектурных решений – показывает механизм исполнения, паттерны, взаимодействие модулей.
• Верификация/аудит – заказчик или аудитор может проверить корректность.
• Поддержка и сопровождение – облегчает понимание кода без просмотра репозитория.
• Юридическая фиксация – приложение к актам, патентам, R&D-материалам.

Где и когда используется листинг

Как вставлять листинг: структура и оформление

Как сделать листинг кода в Word по ГОСТ:

1. Выберите фрагмент программы — точку входа, алгоритм или значимый блок.
2. Добавьте заголовок: «Листинг 1 — пример функции» или «Листинг программы для валидации данных».
3. Используйте моноширинный шрифт для кода (Courier New, Consolas).
4. Установите отступ 2 см и одинарный интервал.
5. Пояснение — до или после листинга, поясняющее его смысл.
6. Нумерация строк — опционально, если нужна трассировка.

 Пример в тексте:

Листинг 1 — Пример валидации входных данных

def validate_id(input):
    if not isinstance(input, str):
        raise ValueError()

 Пример в приложении:

Приложение А
ТЕКСТ ПРОГРАММЫ "AUTH-MODULE"

Листинг 3 — Основной метод инициализации:

public void init() {
    config.load();
    logger.start();
}

Как оформить листинг в Word по ГОСТ

1. Чтобы сделать листинг программы в Word по ГОСТ, вставьте код через «Вставка → Текст».
2. Используйте моноширинный шрифт Courier New или Consolas, размер 10 pt.
3. Если вы оформляете листинг кода в дипломе или курсовой, добавьте подпись «Листинг 1 — пример кода программы».
4. Для аккуратности можно поместить листинг в таблицу без границ.

Типичные ошибки

• Пропорциональный шрифт — искажает отступы и делает листинг программы в Word нечитабельным.
• Также не используйте цветной синтаксис — листинг кода по ГОСТ оформляется только в чёрно-белом цвете.
• Выравнивание по ширине – недопустимо, так как нарушает структуру кода.
• Отсутствие пояснения – код выглядит вырванным из контекста.

Примеры применимости

Вывод

Листинг программы — это не просто код, а часть документации, которая показывает, как реализована логика программы. Оформление листинга по ГОСТ делает код понятным, единообразным и пригодным для аудита. Если вы не знаете, как оформить листинг по ГОСТ или вставить код в Word, используйте приведённые правила и примеры.

Что это даёт бизнесу

• Прозрачность — понятная реализация на всех этапах.
• Юридическая защищённость — формальное подтверждение исполнения.
• Сокращение времени поддержки — доступ к сути без анализа всей кодовой базы.
• Упрощение приёмки — лучшее понимание у заказчиков и аудиторов.
• Рост доверия — демонстрация зрелости подхода.

Что дальше

Если вы хотите систематизировать техническую документацию или оформить программные материалы по ГОСТ, ISO или IEEE — команда Etence поможет адаптировать стандарты под ваш проект. 

Мы можем разработать шаблоны, описания, внедрить процессы и обучить команду оформлению проектных материалов.

17.05.2025 (обн. 06.11.2025)