Coding style/ru: what changed
Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | - | ||
| 2 | - | ||
| 3 | - | ||
| 4 | - | ||
| 5 | - | ||
| 6 | - | ||
| 7 | - | ||
| 8 | - | ||
| 9 | - | ||
| 10 | - | ||
| 11 | - | ||
| 12 | - | ||
| 13 | - | ||
| 14 | - | ||
| 15 | - | ||
| 16 | - | ||
| 17 | 1 | ## Компилятор FPC и RTL | |
| 18 | 2 | ||
| 19 | 3 | ### Введение | |
| 20 | 4 | ||
| 21 | - | ||
| 5 | + | Некоторые люди могут подумать, что стиль кодирования, используемый в исходниках компилятора FPC и базовой RTL (run-time library) - немного странный, но он использовался много лет и не является предметом обсуждения. Поэтому воспринимайте всё нижеследующее как стандарт для использования. | |
| 22 | 6 | ||
| 23 | 7 | ### Зарезервированные слова | |
| 24 | 8 | ||
| 25 | - | ||
| 9 | + | Пишите зарезервировенные слова в нижнем регистре. Не надо делать их нечитаемыми, набирая в верхнем регистре. Современные IDE поддерживают подсветку синтаксиса, поэтому зарезервированные слова легко распознаются. | |
| 26 | 10 | ||
| 27 | 11 | ### Пробелы | |
| 28 | 12 | ||
| 29 | - | ||
| 30 | - | ||
| 31 | - | ||
| 13 | + | Не используйте пробелы вокруг операторов, двоеточий, скобок и т.д.,\ | |
| 14 | + | т.е. пишите | |
| 15 | + | ||
| 16 | + | ``` pascal | |
| 32 | 17 | p:=p+i; | |
| 33 | 18 | ``` | |
| 34 | 19 | ||
| 35 | - | ||
| 36 | - | ||
| 20 | + | вместо | |
| 21 | + | ||
| 22 | + | ``` pascal | |
| 37 | 23 | p := p + i ; | |
| 38 | 24 | ``` | |
| 39 | 25 | ||
| 40 | 26 | ### Символы табуляции | |
| 41 | 27 | ||
| 42 | - | ||
| 28 | + | Не используйте символы табуляции ([[ASCII]] HT, 0x09). Нет стандартных установок по умолчанию для символов табуляции, поэтому то, как при просмотре будут выглядеть исходные файлы, использующие символы табуляции, будет зависеть от настроек клиента. Это может привести к хаотичному виду исходных файлов. Для выравнивания используйте символы пробела (см. также *Отступы*). | |
| 43 | 29 | ||
| 44 | 30 | ### Отступы | |
| 45 | 31 | ||
| 46 | - | ||
| 32 | + | Размер отступа всегда - 2 пробела на уровень. | |
| 47 | 33 | ||
| 48 | - | ||
| 34 | + | Никогда не располагайте **begin** на той-же строке, что **while..do**, **if..then** и т.д., а всегда - на его собственной отдельной строке (и делайте отступ относительно **while**, **if** и т.д.). | |
| 49 | 35 | ||
| 50 | 36 | ### Переводы строк | |
| 51 | 37 | ||
| 52 | - | ||
| 38 | + | Отделяйте подпрограммы тремя переводами строк, т.е. помещайте между ними две пустые строки. | |
| 53 | 39 | ||
| 54 | 40 | ### Разное | |
| 55 | 41 | ||
| 56 | - | ||
| 57 | - | ||
| 42 | + | Пожалуйста, обратите внимание, что если после **else** идёт **if**, то дополнительного отступа не делается: | |
| 43 | + | ||
| 44 | + | ``` pascal | |
| 58 | 45 | if x then | |
| 59 | - | ||
| 60 | - | ||
| 61 | - | ||
| 62 | - | ||
| 63 | - | ||
| 64 | - | ||
| 65 | - | ||
| 46 | + | begin | |
| 47 | + | ... | |
| 48 | + | end | |
| 49 | + | else if y then | |
| 50 | + | begin | |
| 51 | + | ... | |
| 52 | + | end; | |
| 66 | 53 | ``` | |
| 67 | 54 | ||
| 68 | - | ||
| 69 | - | ||
| 70 | - | ||
| 55 | + | Разделяйте все составные условия оператора **if** на несколько строк, т.е. пишите\ | |
| 56 | + | не так: | |
| 57 | + | ||
| 58 | + | ``` pascal | |
| 71 | 59 | if (x) and (y) then | |
| 72 | 60 | ``` | |
| 73 | 61 | ||
| 74 | - | ||
| 75 | - | ||
| 62 | + | а так: | |
| 63 | + | ||
| 64 | + | ``` pascal | |
| 76 | 65 | if x and | |
| 77 | - | ||
| 78 | - | ||
| 66 | + | y then | |
| 67 | + | ... | |
| 79 | 68 | ``` | |
| 80 | 69 | ||
| 81 | - | ||
| 70 | + | (возможно, за исключением случаев, когда *x* и *y* - просто логические переменные) | |
| 82 | 71 | ||
| 83 | 72 | ### Примеры | |
| 84 | 73 | ||
| 85 | - | ||
| 74 | + | Для того, чтобы убедиться, как всё это выглядит, можно заглянуть в [Исходники FPC](http://www.freepascal.org/cgi-bin/viewcvs.cgi/?root=fpc). | |
| 86 | 75 | ||
| 87 | 76 | ## FCL | |
| 88 | 77 | ||
| 89 | - | ||
| 78 | + | Нет формальных стандартов. | |
| 90 | 79 | ||
| 91 | 80 | ## Другие пакеты, поставляемые с FPC | |
| 92 | 81 | ||
| 93 | - | ||
| 82 | + | Нет формальных стандартов. | |
| 94 | 83 | ||
| 95 | 84 | ## Lazarus | |
| 96 | 85 | ||
| 97 | - | ||
| 86 | + | Поскольку Lazarus и LCL следуют совместимости с Delphi, стиль кода сходен с тем, который используется в Delphi. | |
| 98 | 87 | ||
| 99 | - | ||
| 88 | + | Если вы пишете патч или расширение для LCL, вам следует придерживаться стиля LCL. | |
| 100 | 89 | ||
| 101 | - | ||
| 90 | + | Если вы разрабатываете свой собственный компонент, вы можете использовать любой стиль, который вам нравится, но рекомендуется так-же использовать стиль LCL. | |
| 102 | 91 | ||
| 103 | 92 | Смотрите указания по кодированию Lazarus: [[DesignGuidelines/ru]] | |
| 104 | 93 | ||
| 105 | - | ||
| 106 | - | ||
| 107 | - | ||
| 94 | + | Для справки: вы можете найти описание стиля кодирования Delphi [здесь](http://edn.embarcadero.com/article/10280) | |
| 108 | 95 | ||
| 109 | 96 | ## См. также | |
| 110 | 97 | ||
| 111 | - | ||
| 112 | - | ||
| 98 | + | - [[DesignGuidelines/ru|Указания по кодированию Lazarus: DesignGuidelines/ru]] | |
| 99 | + | - [Описание стиля кодирования Delphi: Object Pascal Style Guide (Charles Calvert)](http://edn.embarcadero.com/article/10280) | |
| 113 | 100 | ||
| 114 | 101 | --- | |
| 115 | - | ||
| 102 | + | *From the Free Pascal wiki, page "Coding style/ru", as it stood on 2020-02-11 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |