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
1.5 KiB
Markdown
30 lines
1.5 KiB
Markdown
---
|
|
title: Coding standards
|
|
localeTitle: Normas de codificación
|
|
---
|
|
### contorno
|
|
|
|
* ¿Por qué codificar estándares?
|
|
* Introducción a PEP 8
|
|
* Comandos
|
|
|
|
### ¿Por qué codificar estándares?
|
|
|
|
La comunidad global de python está creciendo rápidamente, y casi todos usan python. Aquí es donde la legibilidad del código y los estándares uniformes son importantes. Cualquiera en el planeta debería poder leer su código y entender lo que hace. Hay muchos aspectos para entender el código de otros, por ejemplo, comentarios sobre lo que hace una función, dividir lógicamente las tareas entre módulos y funciones, buenos nombres de variables, etc.
|
|
|
|
### Introducción a PEP 8
|
|
|
|
Nos encanta pegarnos a las convenciones. La comunidad de usuarios de Python ha creado un conjunto de estándares, que ahora se toman como convención. Cualquier código de nivel de industria que escriba se ejecuta a través del verificador PEP 8. Por lo tanto, es una buena práctica comenzar a escribir cadenas de documentación para sus clases y funciones, y nombrar variables en minúsculas con guiones bajos apropiados. Puede que valga la pena echar un vistazo a estos estándares antes de comenzar a codificar.
|
|
|
|
[Aquí está el enlace exhaustivo.](https://www.python.org/dev/peps/pep-0008/ "Estándares PEP 8")
|
|
|
|
### Comandos
|
|
|
|
Así es como verificas si tu código de Python cumple con los estándares.
|
|
|
|
```shell
|
|
:~$ pip install pep8
|
|
:~$ pep8 --first myCode.py
|
|
```
|
|
|
|
Esto le dará a todas las líneas que violan los estándares, junto con una breve descripción de las correcciones. |