Мельница данных- Стилевое оформление исходного кода (раздел целиком) (09.11.2024) | (одним файлом) |
Стилевое оформление исходного кода |
Код на языке PascalScript, являющийся частью поставляемого решения, должен быть оформлен в соответствии с изложенными правилами. |
1. Использование строк, пробелов и отступов |
Пустые строки могут повысить читабельность путем группирования секций кода, которые логически связаны между собой. Пробелы, запрещенные к использованию:
Двоеточие для всех объявлений переменных не должно содержать перед собой пробелов и иметь один пробел после перед именем типа. Всегда необходимо использовать два пробела для всех уровней отступа. Другими словами, первый уровень отступает на два пробела, второй на четыре и так далее. Никогда не используйте символы табуляции. Существует несколько исключений из этого правила. Зарезервированные слова var, begin и end, относящиеся к программному блоку вцелом, всегда должны примыкать к левой границе. Код внутри блока begin..end должен иметь отступ два символа. Все строки должны быть ограничены 80 столбцами. Строки, длиннее чем 80 столбцов должны быть разделены и перенесены. Все перенесенные строки должны быть выровнены по первой строке и иметь отступ в два символа. Зарезервированное слово begin всегда должно находиться на своей отдельной строке. Нельзя переносить строки в тех местах, где не допускаются пробелы, например между именем метода и открывающей скобкой. Никогда нельзя помещать зарезервированное слово begin на строку, содержащую другой код. |
2. Оформление объявлений и операторов | ||||||||||||||||||||||||||
Все переменные с их типами должны быть объявлены на различных строках. Простые операторы содержат одну точку с запятой. Если Вам необходимо разделить оператор, то перенесите продолжение оператора на следующую строку с отступом в два пробела.
Составные операторы всегда заканчиваются точкой с запятой.
Каждое присвоение и каждое выражение должно располагаться на разных строках. Оператор "if" Оператор if всегда должен располагаться по крайней мере на двух строках
Оператор "for"
Оператор "while"
Оператор "repeat..until"
Оператор "case" Несмотря на то, что существует множество синтаксически правильных конструкций, одобренной и рекомендованной считается следующая:
Оператор "try" Несмотря на то, что существует множество синтаксически правильных конструкций, одобренной и рекомендованной считается следующая:
|