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