0a1eeea424
* fix: replace sh with shell fix replace terminal with shell fix replace node with js fix replace output with shell fix replace cs with csharp fix replace c++ with cpp fix replace c# with csharp fix replace javasctipt with js fix replace syntax with js fix replace unix with shell fix replace linux with shell fix replace java 8 with java fix replace swift4 with swift fix replace react.js with jsx fix replace javascriot with js fix replace javacsript with js fix replace c++ - with cpp fix: corrected various typos fix: replace Algorithm with nothing fix: replace xaml with xml fix: replace solidity with nothing fix: replace c++ with cpp fix: replace txt with shell fix: replace code with json and css fix: replace console with shell
30 lines
2.4 KiB
Markdown
30 lines
2.4 KiB
Markdown
---
|
||
title: Coding standards
|
||
localeTitle: Стандарты кодирования
|
||
---
|
||
### Контур
|
||
|
||
* Почему стандарты кодирования?
|
||
* Введение в PEP 8
|
||
* команды
|
||
|
||
### Почему стандарты кодирования?
|
||
|
||
Глобальное сообщество python быстро растет, и почти каждый использует python. Здесь важна читаемость кода и единообразных стандартов. Любой человек на планете должен уметь читать ваш код и понимать, что он делает. Существует много аспектов понимания кода другого пользователя, например комментарии о том, что делает функция, логическое разделение задач между модулями и функциями, хорошие имена переменных и т. Д.
|
||
|
||
### Введение в PEP 8
|
||
|
||
Мы любим придерживаться конвенций. Сообщество пользователей python разработало набор стандартов, которые теперь принимаются как конвенции. Любой код уровня отрасли, который вы пишете, запускается через контрольную панель PEP 8. Поэтому хорошей практикой является начало написания docstrings для ваших классов и функций и переименование переменных в нижнем регистре с соответствующими символами подчеркивания. Возможно, стоит взглянуть на эти стандарты, прежде чем начинать кодирование.
|
||
|
||
[Вот исчерпывающая ссылка](https://www.python.org/dev/peps/pep-0008/ "Стандарты PEP 8")
|
||
|
||
### команды
|
||
|
||
Вот как вы проверяете, соответствует ли ваш код Python его стандартам.
|
||
|
||
```shell
|
||
:~$ pip install pep8
|
||
:~$ pep8 --first myCode.py
|
||
```
|
||
|
||
Это даст все те строки, которые нарушают стандарты, а также краткое описание исправлений. |