Google Style Guides
The main goal of the fork is to give a translation of C++ Google Style Guide into Russian. So …
Руководства по стилю от Google
Наверное, у каждого известного проекта с открытым исходным кодом есть руководство по стилю: набор соглашений (иногда противоречивых) о том, как писать код для проекта. Обусловлено это тем, что намного легче понять код, особенно когда его очень много, если он оформлен единообразно.
“Руководство” охватывает множество областей, от правил именования переменных до использования глобальных переменных или исключений. Этот проект (evgenykislov/styleguide) объединяет руководства, которые (в исходной редакции) используются в коде для Google. Если вы редактируете код от Google, то здесь можно прочитать о тех принципах по которым он оформляется.
- AngularJS Style Guide
- Common Lisp Style Guide
- Руководство по стилю C++ (рус), C++ Style Guide (eng)
- C# Style Guide
- Go Style Guide
- HTML/CSS Style Guide
- JavaScript Style Guide
- Java Style Guide
- JSON Style Guide
- Markdown Style Guide
- Objective-C Style Guide
- Python Style Guide
- R Style Guide
- Shell Style Guide
- Swift Style Guide
- TypeScript Style Guide
- Vim script Style Guide
Также здесь есть cpplint - инструмент, помогающий соответствовать стилю, и google-c-style.el - файл с настройками для Emacs.
Кроме того, если в проекте требуется новый формат XML-документа, то обратите внимание на XML Document Format. В дополнение к текущим правилам он содержит советы по созданию своих собственных правил или адаптации существующих, форматированию XML-документа, использованию элементов и атрибутов.
Руководства по стилю в этом проекте распространяются под лицензией CC-By 3.0 License, которая позволяет вам распространять эти документы. Подробнее можно прочитать на https://creativecommons.org/licenses/by/3.0/.
Также есть ещё руководства, которое размещается отдельно, вне проекта:
Внешнее участие
Руководства по стилю (за небольшими исключениями) скопированы с внутренних документов Google с целью помочь разработчикам работать над проектами Google или проектами с открытым исходным кодом. Как результат, изменения в руководствах по стилю делаются сначала во внутренних документах, потом изменения копируются во внешний документ. Внешнее участие не допускается. Pull request обычно закрываются без объяснения причин. Допустимо зарегистрировать проблему в трекере GitHub. Очевидные ошибки или технические неточности теоретически могут быть приняты, однако в любом случае документы изменяются с учётом внутреннего применения в Google.
Google Style Guides
Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.
“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This project (google/styleguide) links to the style guidelines we use for Google code. If you are modifying a project that originated at Google, you may be pointed to this page to see the style guides that apply to that project.
- AngularJS Style Guide
- Common Lisp Style Guide
- C++ Style Guide
- C# Style Guide
- Go Style Guide
- HTML/CSS Style Guide
- JavaScript Style Guide
- Java Style Guide
- JSON Style Guide
- Markdown Style Guide
- Objective-C Style Guide
- Python Style Guide
- R Style Guide
- Shell Style Guide
- Swift Style Guide
- TypeScript Style Guide
- Vim script Style Guide
This project also contains cpplint, a tool to assist with style guide compliance, and google-c-style.el, an Emacs settings file for Google style.
If your project requires that you create a new XML document format, the XML Document Format Style Guide may be helpful. In addition to actual style rules, it also contains advice on designing your own vs. adapting an existing format, on XML instance document formatting, and on elements vs. attributes.
The style guides in this project are licensed under the CC-By 3.0 License, which encourages you to share these documents. See https://creativecommons.org/licenses/by/3.0/ for more details.
The following Google style guide lives outside of this project:
Contributing
With few exceptions, these style guides are copies of Google’s internal style guides to assist developers working on Google owned and originated open source projects. Changes to the style guides are made to the internal style guides first and eventually copied into the versions found here. External contributions are not accepted. Pull requests are regularly closed without comment.
People can file issues using the GitHub tracker. Issues that raise questions, justify changes on technical merits, or point out obvious mistakes may get some engagement and could in theory lead to changes, but we are primarily optimizing for Google’s internal needs.
Описание
Руководство по стилю для C++ open-source проектов. На русском.