DesignGuidelines/ru: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | ## Указания по кодированию для Lazarus | |
| 2 | 2 | ||
| 3 | - | ||
| 4 | - | ||
| 3 | + | Стиль кодирования | |
| 5 | 4 | ||
| 6 | - | ||
| 7 | - | ||
| 5 | + | - Поскольку один стиль легче для чтения, Lazarus следует стилю, принятому для Delphi: [Object Pascal Style Guide](http://edn.embarcadero.com/article/10280). Конечно, почти любой найдёт там моменты, которые посчитает менее удобными для чтения, чем в других стилях. Это нормально, просто попробуйте следовать этому стилю хотя бы на 90%. В качестве примера смотрите LCL. | |
| 6 | + | - Старайтесь избегать взаимных (циклических) ссылок модулей (**uses** в секциях **implementation**). Причины: | |
| 8 | 7 | ||
| 9 | - | ||
| 10 | - | ||
| 8 | + | 1. FPC имеет проблемы с ними. | |
| 9 | + | 2. Это позволяет разделить модули и пакеты, когда они становятся слишком большими. | |
| 11 | 10 | ||
| 12 | - | ||
| 13 | - | ||
| 14 | - | ||
| 15 | - | ||
| 11 | + | - Минимизируйте количество вызовов LCL интефейсами при выполнении действия, запрошенного LCL. Интерфейсы только уведомляют LCL, не заставляя что-либо делать. Решение принимает LCL. | |
| 12 | + | - Соглашения об именовании: см. [[Nomenclature]] | |
| 13 | + | - Весь код должен работать при всех включенных проверках (range, I/O, overflow, stack). Помимо того, что это помогает отладке, некоторые пользователи устанавливают эти проверки в fpc.cfg, поэтому они применяются ко всему Lazarus, включая пакеты и примеры. | |
| 14 | + | - Имена в комментариях: Комментарии должны помогать читателю. Они - не для прославления писателя. Вы можете добавить имя, если: | |
| 16 | 15 | ||
| 17 | - | ||
| 18 | - | ||
| 16 | + | 1. Вы занимаетесь поддержкой, т.е. являетесь тем, кто принимает отчёты об ошибках. | |
| 17 | + | 2. Имя удобно для поисковых запросов, чтобы найти помощь по этой теме. | |
| 19 | 18 | ||
| 20 | - | ||
| 21 | - | ||
| 19 | + | Новые файлы | |
| 22 | 20 | ||
| 23 | - | ||
| 24 | - | ||
| 21 | + | - Каждый файл должен начинаться с заголовка, содержащего лицензию и несколько строк, описывающих содержание. | |
| 22 | + | - Исходные файлы на языке Pascal (.pas, .pp, .inc, .lfm, .lrs) должны иметь имена в нижнем регистре. Можно использовать CamelCase в именах модулей. | |
| 25 | 23 | ||
| 26 | - | ||
| 27 | - | ||
| 24 | + | Включаемые файлы | |
| 28 | 25 | ||
| 29 | - | ||
| 26 | + | - Должны начинаться директивой {%MainUnit } | |
| 30 | 27 | ||
| 31 | - | ||
| 32 | - | ||
| 28 | + | Пакеты | |
| 33 | 29 | ||
| 34 | - | ||
| 35 | - | ||
| 30 | + | - Должны иметь запись .lpl в packager/globallinks/ | |
| 31 | + | - Должны иметь автора, описание и лицензию | |
| 36 | 32 | ||
| 37 | - | ||
| 38 | - | ||
| 33 | + | Пункты главного меню | |
| 39 | 34 | ||
| 40 | - | ||
| 35 | + | - Должны иметь клавишу в keymapping.pp | |
| 41 | 36 | ||
| 42 | - | ||
| 37 | + | ------------------------------------------------------------------------ | |
| 43 | 38 | ||
| 44 | - | ||
| 39 | + | *Надёжная версия может быть найдена в [svn](http://svn.freepascal.org/svn/lazarus/trunk/docs/DesignGuidelines.txt). Предложения по улучшению могут быть добавлены на странице обсуждения*. | |
| 45 | 40 | ||
| 46 | 41 | ### GUI | |
| 47 | 42 | ||
| 48 | 43 | См. [[GUI design guidelines]] | |
| 49 | 44 | ||
| 50 | 45 | ## См. также | |
| 51 | 46 | ||
| 52 | - | ||
| 53 | - | ||
| 47 | + | - [Описание стиля кодирования Delphi: Object Pascal Style Guide (Charles Calvert)](http://edn.embarcadero.com/article/10280) | |
| 48 | + | - Стандарт кодирования для Free Pascal (FPC) (используется для компилятора и другого кода FPC): [[Coding style/ru]] | |
| 54 | 49 | ||
| 55 | 50 | --- | |
| 56 | - | ||
| 51 | + | *From the Free Pascal wiki, page "DesignGuidelines/ru", as it stood on 2016-01-22 after a change by FTurtle, 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).* |