color - Comentarios de Python:#vs. cuerdas

plotly layout

Question

Con respecto a la forma "estándar" de colocar comentarios dentro del código fuente de Python:

def func():
"Func doc"
... <code>
''TODO: fix this''
#badFunc()
... <more code>
def func():
"Func doc"
... <code>
#TODO: fix this
#badFunc()
... <more code>

Prefiero escribir comentarios generales como cadenas en lugar de prefijar # ''s. La guía de estilo oficial de Python no menciona el uso de cadenas como comentarios (si no me la perdí al leerla).

Me gusta que sea así principalmente porque creo que el carácter # ve feo con los bloques de comentarios. Por lo que sé, estas cuerdas no hacen nada.

¿Hay desventajas en hacer esto?

Answer 1

Creo que solo el primer literal de cadena en una definición (o clase) es "especial", es decir, el intérprete lo almacena en la cadena de documentos del objeto definido (o clase '').

Cualquier otro literal de cadena que coloque en el código significará, en el peor de los casos, que el intérprete construirá el valor de la cadena en el tiempo de ejecución y luego lo tirará. Esto significa que hacer "comentarios" desparramando el código con constantes de cadena podría costar, en términos de rendimiento.

Por supuesto, no lo he evaluado, y tampoco conozco al intérprete de Python lo suficiente como para decirlo con seguridad.

Answer 2

La desventaja, por supuesto, es que otra persona que lo lea encontrará que las cadenas de código y las cadenas de comentarios están intercaladas, lo que podría ser confuso.

Answer 3

No haga mal uso de las cadenas (declaraciones sin oposiciones) como comentarios. Las cadenas de documentación, por ejemplo, la primera cadena en un módulo, clase o función, son especiales y definitivamente recomendadas.

Tenga en cuenta que las cadenas de documentación son documentación y que la documentación y los comentarios son dos cosas diferentes.

• La documentación es importante para entender lo que hace el código.
• Los comentarios explican cómo lo hace el código.

Las personas que utilizan su código leen la documentación y las personas que quieren entender su código, por ejemplo, para mantenerlo.

El uso de cadenas para comentarios tiene las siguientes desventajas (potenciales):

• Confunde a la gente que no sabe que la cuerda no hace nada.
• Los comentarios y los literales de cadena se resaltan de manera diferente en los editores de código, por lo que su estilo puede hacer que su código sea más difícil de leer.
• Podría afectar el rendimiento y / o el uso de la memoria (si las cadenas no se eliminan durante la compilación del código de bytes, la eliminación de comentarios se realiza en el nivel del escáner, por lo que es definitivamente más barato)

Lo más importante para los programadores de Python: no es pythonic:

Debe haber una, y preferiblemente solo una, obvia forma de hacerlo.

Se adhieren a las normas, utilizar comentarios.