← Предыдущая статья

Clean ABAP. A Style Guide for Developers

Klaus Haeuptle, Florian Hoffmann, Rodrigo Jordão, Michel Martin, Anagha Ravinarayan, Kai Westerholz

Разработчики ABAP, очистите свой код! Эта книга изобилует передовым опытом экспертов, которые помогут вам написать эффективный код ABAP. Начните с изучения того, когда применять методы чистого ABAP. Затем погрузитесь в подробные примеры кода и объяснения использования классов, методов, имен, переменных, внутренних таблиц и т. д. Это полное руководство по стилю: от написания кода до устранения неполадок и тестирования.

Каждый программист должен использовать эти общие настройки. Перейти к ним можно по пути «Меню • Утилиты • Настройки • Редактор ABAP • Программа красивой печати» (Menu • Utilities • Settings • ABAP Editor • Pretty Printer), см. Рис. 10.1.

Рис. 10.1. Ведение настроек программы красивой печати

На вкладке «Программа красивой печати» (Pretty Printer) можно задать отступы для кода в определённом блоке, например, в операторах LOOP или IF, либо настроить вывод этих строк в месте написания кода независимо от иерархии. Вы можете задать для всех символов верхний или нижний регистр, указать, что тот или иной регистр используется только для ключевых слов и многое другое.

После установки настроек программы красивой печати код можно улучшить с помощью сочетания клавиш (Shift)+(F1) в транзакциях SE80 или SE24, либо с помощью инструментов разработки ABAP (ABAP Development Tools, ADT). В ADT также можно использовать сочетание клавиш (Ctrl)+(Shift)+(F).

После согласования и применения рабочей группой настроек программы красивой печати весь код в программном обеспечении приобретёт единообразие и станет усладой для глаз пользователей, которые впоследствии будут его читать.

Если при работе с чужим или устаревшим кодом, см. раздел 10.1, требуется изменить или дополнить какой-то фрагмент, рассмотрите возможность применения программы красивой печати только для изменённого фрагмента, а не для всей кодовой базы. Это позволит избежать обработки обширных списков изменений и зависимостей между переносами. Применять программу красивой печати ко всему объекту разработки следует в отдельном запросе на перенос или примечании.

Число операторов на строку и длина строки в контексте чистого кода ABAP

Число операторов на строку (раздел 10.4)

Изучите фрагменты кода в Лист. 10.3 и Лист. 10.4.

READ TABLE employees REFERENCE INTO employee WITH KEY location = 'London'. IF sy-subrc =
0. employee-region = 'UK'. ENDIF.

Лист. 10.3. Все операторы в одной строке

READ TABLE employees REFERENCE INTO employee WITH KEY location = 'London'.
IF sy-subrc = 0.
employee-region = 'UK'.
ENDIF.

Лист. 10.4. Один оператор на строку

Блоки кода в Лист. 10.3 и Лист. 10.4 выполняются совершенно одинаково, поскольку машине неважно, как выглядит код. Системе важна только синтаксическая и динамическая правильность кода. Оба фрагмента кода являются корректными, но удобный для восприятия человеком формат мы видим в Лист. 10.4. Чтобы код оставался удобочитаемым, важно не использовать больше одного оператора на строку, даже если операторы короткие.

Длина строки (раздел 10.5)

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

Программисту будет проще выполнять отладку или параллельное сравнение двух источников, если строки кода будут более короткими. Золотое правило гласит, что на экране ноутбука среднего размера с текстом со средним размером шрифта не должна возникать потребность в горизонтальной прокрутке. Если нас попросят назвать точную длину строки, которая является приемлемой, это значение будет не более 120 символов. Часто звучит рекомендация придерживаться длины строки не более 100 символов, но для ABAP мы считаем значение в 120 символов более удачным вследствие многословности этого языка. Например, если в коде используется оператор IF с несколькими длинными условиями, он, скорее всего, займёт собой всю ширину экрана (или даже больше). Рассмотрите возможность разделить строки по условиям, чтобы сделать фрагмент кода с этим оператором