mirror of
https://github.com/kylelobo/The-Documentation-Compendium.git
synced 2025-09-02 17:42:57 +02:00
* Translate bug_report.md via GitLocalize * Translate CHANGELOG.md via GitLocalize * Translate CHANGELOG.md via GitLocalize * Translate CODEBASE_STRUCTURE.md via GitLocalize * Translate CODEBASE_STRUCTURE.md via GitLocalize * Translate CODE_OF_CONDUCT.md via GitLocalize * Translate CODE_OF_CONDUCT.md via GitLocalize * Translate CODING_GUIDELINES.md via GitLocalize * Translate TODO.md via GitLocalize * Translate PULL_REQUEST_TEMPLATE.md via GitLocalize * Translate CONTRIBUTING.md via GitLocalize * Translate Hackathon.md via GitLocalize * Translate Hackathon.md via GitLocalize * Translate Bot.md via GitLocalize * Translate Bot.md via GitLocalize * Translate Minimal.md via GitLocalize * Translate Minimal.md via GitLocalize * Translate Standard.md via GitLocalize * Translate Standard.md via GitLocalize * Translate feature_request.md via GitLocalize * Translate custom.md via GitLocalize * Update CONTRIBUTING.md * Update custom.md * Update bug_report.md * Update feature_request.md * Update Minimal.md * Update Standard.md Co-authored-by: mt-gitlocalize <mt@gitlocalize.com>
2.1 KiB
2.1 KiB
Гайдлайн по написанию кода
- Вы можете проверить, соответствует ли ваш код этому гайдлайну, запустив
stuff/php-format.py validate
- Табуляция, без пробелов
- Конец строки должен быть в стиле Unix (
\n
), а не в стиле Windows (\r\n
) - Открывающие скобки находятся в той же строке, что и последний оператор.
if (condition) {
stuff;
}
- Пробел между ключевыми словами и круглыми скобками для:
if
,else
,while
,switch
,catch
,function
- В вызовах функций нет пробела перед круглыми скобками
- В скобках нет пробелов
- Пробел после каждой запятой, но без пробела перед
- Все бинарные операторы должны иметь один пробел до и один после
- Не должно быть более одной непрерывной пустой строки
- Пустых комментариев быть не должно
- Вы не должны использовать блоки комментариев
/ * ... * /
, только строку// ...
- Изменения в функциональности должны сопровождаться соответствующими новыми/ модифицированными тестами
- Исключения должны использоваться для сообщения об ошибочных состояниях. Использование функций, возвращающих true/false, разрешено, когда они являются ожидаемыми значениями
- При необходимости используйте [RAII] (http://en.wikipedia.org/wiki/Resource_Acquisition_Is_Initialization), в основном при администрировании ресурсов (файлов и т. д.)