Meta tags:
description= Aprende a escribir comentarios de una línea y multilínea en Python, cuándo usar docstrings, comentarios en línea y buenas prácticas con ejemplos.;
Headings (most frequently used words):
comentarios, de, línea, una, multilínea, buenas, prácticas, la, directivas, para, en, python, docstrings, documentación, estructurada, comentar, código, durante, depuración, especiales, errores, comunes, que, debes, evitar, resumen, práctica, cuándo, usar, strings, triple, comillas, como, bloque, shebang, declaración, codificación, verificadores, tipos,
Text of the page (most frequently used words):
python (77), comentarios (33), una (23), línea (23), que (21), #código (20), los (17), the (17), con (17), aprender (15), para (14), matplotlib (14), copiar (13), string (13), mysql (13), mongodb (12), elementos (11), comentario (10), por (9), multilínea (8), variables (8), líneas (8), price (8), print (8), listas (8), w3docs (7), html (7), this (7), comment (7), def (7), rate (7), tuplas (7), archivos (6), usa (6), return (6), tipos (6), strings (6), eliminar (6), métodos (6), datos (6), code (5), práctica (5), buenas (5), prácticas (5), documentación (5), sintaxis (5), before (5), vez (5), utf (5), docstring (5), usar (5), todo (5), qué (5), como (5), crear (5), primeros (5), pasos (5), tutorial (5), lista (5), formatter (5), color (5), json (4), generator (4), git (4), errores (4), durante (4), depuración (4), using (4), triple (4), and (4), cada (4), tipo (4), después (4), archivo (4), base (4), pero (4), tax (4), script (4), intérprete (4), 100 (4), tiene (4), greet (4), name (4), regresión (4), diccionarios (4), acceder (4), encoder (3), editor (3), herramientas (3), cuestionarios (3), ejercicios (3), php (3), javascript (3), css (3), desde (3), directivas (3), especiales (3), comentar (3), docstrings (3), add (3), son (3), consulta (3), type (3), ignore (3), fuente (3), codificación (3), python3 (3), class (3), estilo (3), forma (3), lugar (3), deben (3), file (3), sin (3), bloque (3), set (3), cambiar (3), primera (3), hello (3), las (3), calculate_discount (3), discount (3), módulo (3), csv (3), comillas (3), celsius_to_fahrenheit (3), cuándo (3), area (3), cadenas (3), recorrer (3), unir (3), ver (3), tools (3), todos (2), italiano (2), português (2), español (2), français (2), русский (2), deutsch (2), english (2), beautifier (2), diff (2), password (2), try (2), java (2), libros (2), ejemplos (2), fragmentos (2), resumen (2), comunes (2), debes (2), evitar (2), estructurada (2), page (2), line (2), symbol (2), which (2), following (2), are (2), ways (2), comments (2), according (2), com (2), valor (2), mismo (2), mypy (2), coding (2), entrada (2), unix (2), usr (2), bin (2), env (2), shebang (2), api (2), text (2), explicaciones (2), consecutivas (2), hace (2), comentado (2), grandes (2), útiles (2), estar (2), sistema (2), data (2), txt (2), where (2), dejar (2), tax_rate (2), decimal (2), for (2), sigue (2), misma (2), almohadilla (2), espacio (2), instrucción (2), dos (2), necesita (2), evita (2), skip (2), empty (2), cuando (2), result (2), explica (2), convenciones (2), genuinamente (2), tiempo (2), ejecución (2), capítulo (2), más (2), sobre (2), cómo (2), verificadores (2), caracteres (2), comienza (2), ejecuta (2), from (2), with (2), puede (2), lectores (2), else (2), formula (2), temporalmente (2), este (2), funciones (2), report (2), sales (2), literales (2), __doc__ (2), alice (2), str (2), greeting (2), returns (2), args (2), colocado (2), estándar (2), del (2), múltiples (2), sola (2), uno (2), user_count (2), decisión (2), radius (2), escribir (2), handling (2), números (2), clases (2), limit (2), colección (2), delete (2), ordenar (2), cuadrícula (2), dispersión (2), distribución (2), introducción (2), bucles (2), conjuntos (2), sets (2), agregar (2), hash (2), 2026, derechos, reservados, hecho, desarrolladores, idioma, política, privacidad, contacto, acerca, empresa, tutoriales, gratuitos, web, 2014, next, previous, yes, was, helpful, comprobar, writing, separate, without, any, quotes, after, herramienta, ligera, aportan, otro, desarrollador, futuro, lee, profundizar, temas, relacionados, suprimir, ignorar, usan, punto, scripts, pública, extensas, notas, encabezados, sección, mezcla, parezca, desatendida, acuerda, aplícalo, consistente, inconsistente, control, versiones, preserva, historial, necesario, mantener, posteridad, elimínalo, alguna, necesitas, recuperarlo, log, bloques, eliminarlos, desarrollo, vinculados, seguimiento, incidencias, dejarse, indefinidamente, producción, read, open, handle, case, does, not, exist, rastrearlos, total, including, prices, must, non, negative, validation, happens, upstream, expressed, apply_tax, aplican, tener, sangría, ese, debe, comenzar, luego, separados, menos, espacios, pep, guía, oficial, recomienda, obvios, has, space, correct, lines, processing, oraciones, completas, obsoletos, contradigan, actualiza, cambies, mantén, actualizados, cache, avoid, redundant, calls, buen, ejemplo, seguir, estas, hará, tus, sean, estos, suprimen, específicos, comportamiento, información, maneja, value, some_function, respetan, defecto, esto, rara, hoy, día, puedes, encontrarlo, heredado, distinta, predeterminado, declárala, segunda, declaración, esta, respecta, operativo, directamente, standalone, tells, run, sistemas, especificar, sus, reconocen, algunas, tienen, significado, legible, máquina, hayas, confirmado, corrección, elimina, comentadas, dejarlas, permanente, obsoleto, confunde, futuros, old, flat, deshabilitar, técnica, habitual, patrón, funciona, costo, sutil, diferencia, analiza, conservarlo, bytecode, compilado, nivel, prefiere, adecuado, otras, dentro, usando, import, writes, summary, reads, aggregates, region, processes, daily, dado, descarta, están, asignados, nada, solo, posición, veces, informal, prints, above, person, personalised, message, convención, especial, llamada, abreviatura, documentation, inmediatamente, cabecera, aunque, técnicamente, expresión, sirve, mecanismo, accesible, través, atributo, mayoría, editores, ides, permiten, seleccionar, alternar, todas, ellas, generalmente, cmd, ctrl, 212, round, float, rounded, two, places, function, converts, temperature, celsius, fahrenheit, dedicada, idiomática, abarcar, varias, consecutivos, comenzando, total_score, average, division, zero, fixme, deshabilita, marca, soluciones, temporales, replace, database, lookup, tomó, muestra, última, ejecutable, llama, úsalos, moderación, resérvalos, lógica, obvia, repetir, dice, outputs, 53975, 14159, calculate, circle, carácter, hasta, final, esa, ignorado, ignora, completo, existen, humanos, explicar, intención, documentar, decisiones, señalar, problemas, afectar, programa, cubre, mantienen, legibles, bases, aprende, peticiones, http, pytest, paquetes, entornos, virtuales, tooling, best, practices, threading, asyncio, concurrency, random, sys, itertools, collections, lanzar, excepciones, error, standard, library, sumar, invertir, duplicados, how, enumeraciones, abstractas, encapsulamiento, polimorfismo, dataclasses, static, classmethod, property, mágicos, advanced, oop, sentencia, match, enumerate, zip, map, comprensiones, gestores, contexto, recursión, closures, generadores, decoradores, kwargs, sugerencias, intermediate, actualización, find, insertar, join, update, drop, table, order, select, insert, tabla, vecinos, cercanos, curva, auc, roc, validación, cruzada, agregación, bootstrap, means, categóricos, búsqueda, logística, agrupamiento, jerárquico, matriz, confusión, árbol, train, test, escalar, múltiple, polinomial, lineal, diagrama, normal, percentil, desviación, media, mediana, moda, machine, learning, gráficos, pastel, histogramas, barras, subplot, etiquetas, marcadores, trazado, pyplot, django, scipy, pandas, numpy, modules, leer, manejo, formateo, usuario, except, pip, regex, matemáticas, fechas, módulos, ámbito, iteradores, herencia, objetos, arrays, lambda, while, operadores, booleanos, casting, nombres, actualizar, desempaquetar, tupla, segmentación, home, salida, anidados, modificar, iterar, comprensión, globales, formato, escape, diccionario, concatenar, asignar, valores, conjunto, añadir, iniciar, sesión, buscar, formatters, url, reverse, sha256, md5, length, calculator, colors, hsl, hex, mixer, converter, picker, general, cursos,
Text of the page (random words):
comentarios en python una línea multilínea y buenas prácticas w3docs w3docs libros aprender html aprender css aprender javascript aprender git aprender java aprender php aprender python cursos cuestionarios ejercicios fragmentos herramientas general tools html editor password generator html encoder code diff json beautifier ver los 13 color tools color picker color converter color mixer color hex colors hsl ver los 10 string tools string length calculator md5 hash generator sha256 hash generator string reverse url encoder ver los 19 code formatters javascript formatter css formatter html formatter json formatter php formatter buscar en w3docs k es english en deutsch de русский ru français fr español es português pt italiano it iniciar sesión aprender python python tutorial acceder a elementos acceder a elementos de lista acceder a elementos de un set acceder a tuplas agregar elementos añadir elementos a una lista agregar elementos a un conjunto asignar múltiples valores cambiar elementos cambiar elementos de una lista concatenar strings copiar diccionarios copiar listas métodos de diccionario caracteres de escape cadenas de formato variables globales unir listas unir sets unir tuplas comprensión de listas métodos de lista iterar sobre diccionarios recorrer listas recorrer sets recorrer tuplas modificar strings diccionarios anidados variables de salida python home listas de python conjuntos en python python strings tuplas en python variables en python eliminar elementos eliminar elementos de una lista eliminar elementos de un set métodos de conjuntos segmentación de cadenas ordenar listas métodos de string métodos de tupla desempaquetar tuplas actualizar tuplas nombres de variables introducción a python primeros pasos con python sintaxis de python comentarios en python variables en python tipos de datos en python números en python casting en python strings de python booleanos en python operadores de python listas de python tuplas de python diccionarios en python python if else bucles while en python bucles for en python funciones en python python lambda arrays en python clases y objetos en python herencia en python iteradores de python ámbito en python módulos de python fechas en python matemáticas en python python json python regex python pip python try except entrada de usuario en python formateo de cadenas en python file handling manejo de archivos en python leer archivos en python escribir crear archivos en python eliminar archivos en python python modules tutorial de numpy tutorial de pandas tutorial de scipy tutorial de django python matplotlib introducción a matplotlib primeros pasos con matplotlib matplotlib pyplot trazado con matplotlib marcadores de matplotlib líneas en matplotlib etiquetas en matplotlib cuadrícula de matplotlib subplot de matplotlib dispersión en matplotlib barras en matplotlib histogramas con matplotlib gráficos de pastel con matplotlib machine learning primeros pasos media mediana moda desviación estándar percentil distribución de datos distribución normal de datos diagrama de dispersión regresión lineal regresión polinomial regresión múltiple escalar train test árbol de decisión matriz de confusión agrupamiento jerárquico regresión logística búsqueda en cuadrícula datos categóricos k means agregación bootstrap validación cruzada curva auc roc k vecinos más cercanos python mysql primeros pasos con mysql mysql crear base de datos mysql crear tabla mysql insert mysql select mysql where mysql order by mysql delete mysql drop table mysql update mysql limit mysql join python mongodb primeros pasos con mongodb crear base de datos mongodb mongodb crear colección insertar en mongodb mongodb find consulta mongodb ordenar en mongodb mongodb delete eliminar colección en mongodb actualización en mongodb mongodb limit intermediate python f strings sugerencias de tipo args kwargs decoradores generadores closures recursión gestores de contexto comprensiones enumerate zip map sentencia match advanced oop métodos mágicos property static y classmethod dataclasses polimorfismo encapsulamiento clases abstractas enumeraciones python how to eliminar duplicados en listas invertir un string sumar dos números error handling and the standard library lanzar excepciones collections itertools os sys random archivos csv concurrency in python asyncio threading python tooling and best practices entornos virtuales paquetes pytest peticiones http comentarios en python una línea multilínea y buenas prácticas aprende a escribir comentarios de una línea y multilínea en python cuándo usar docstrings comentarios en línea y buenas prácticas con ejemplos los comentarios son líneas en tu código fuente que el intérprete de python ignora por completo existen para los lectores humanos para explicar la intención documentar decisiones y señalar problemas sin afectar cómo se ejecuta el programa este capítulo cubre todos los tipos de comentarios en python cuándo usar cada uno y las convenciones que mantienen legibles las bases de código grandes comentarios de una línea un comentario de una línea comienza con el carácter almohadilla todo lo que va desde el hasta el final de esa línea es ignorado por el intérprete calculate the area of a circle radius 5 area 3 14159 radius 2 print area outputs 78 53975 copiar el comentario en la última línea colocado después del código ejecutable en la misma línea se llama comentario en línea úsalos con moderación resérvalos para lógica genuinamente no obvia en lugar de repetir lo que el código ya dice cuándo usar comentarios de una línea explica el por qué se tomó una decisión no el qué hace el código el código muestra el qué marca soluciones temporales todo replace with database lookup deshabilita temporalmente una sola línea durante la depuración fixme division by zero if user_count is 0 average total_score user_count copiar comentarios multilínea python no tiene una sintaxis de comentarios multilínea dedicada como c tiene la forma idiomática de abarcar varias líneas es usar comentarios consecutivos de una sola línea cada uno comenzando con this function converts a temperature in celsius to fahrenheit the formula is f c 9 5 32 returns a float rounded to two decimal places def celsius_to_fahrenheit c return round c 9 5 32 2 print celsius_to_fahrenheit 100 212 0 print celsius_to_fahrenheit 0 32 0 copiar la mayoría de los editores e ides de python te permiten seleccionar múltiples líneas y alternar en todas ellas a la vez generalmente ctrl o cmd docstrings comentarios de documentación estructurada python tiene una convención especial de literales de string llamada docstring abreviatura de documentation string un docstring es un string de triple comillas colocado inmediatamente después de una cabecera def class o de módulo aunque técnicamente es una expresión de string y no un comentario sirve como mecanismo de documentación estándar y es accesible en tiempo de ejecución a través del atributo __doc__ def greet name return a personalised greeting message args name str the name of the person to greet returns str a greeting string return f hello name print greet alice hello alice print greet __doc__ prints the docstring above copiar strings de triple comillas como comentarios de bloque dado que python descarta los literales de string que no están asignados a nada un string de triple comillas por sí solo no en una posición def class a veces se usa como un comentario de bloque informal this script processes the daily sales report it reads from sales csv aggregates by region and writes a summary to report txt import csv copiar este patrón funciona pero tiene un costo sutil a diferencia de los comentarios con el intérprete sí analiza el string y puede conservarlo en el bytecode compilado para la documentación a nivel de módulo prefiere un docstring de módulo adecuado la primera instrucción en el archivo para otras explicaciones multilínea dentro de funciones sigue usando líneas consecutivas con comentar código durante la depuración deshabilitar temporalmente código con comentarios es una técnica de depuración habitual def calculate_discount price rate discount price rate old flat rate formula discount price rate if rate 1 else price rate 100 return price discount print calculate_discount 100 0 2 80 0 print calculate_discount 100 20 80 0 copiar una vez que hayas confirmado la corrección elimina las líneas comentadas en lugar de dejarlas en la base de código de forma permanente el código comentado obsoleto confunde a futuros lectores directivas de comentarios especiales python y sus herramientas reconocen algunas líneas de comentarios que tienen significado legible por máquina la línea shebang en sistemas tipo unix la primera línea de un script puede especificar el intérprete usr bin env python3 this line tells the os to run the file with python3 print hello from a standalone script copiar esta línea es un comentario en lo que respecta a python comienza con pero el sistema operativo la usa cuando el archivo se ejecuta directamente script py declaración de codificación si tu archivo fuente usa una codificación de caracteres distinta de utf 8 el valor predeterminado desde python 3 declárala en la primera o segunda línea coding utf 8 copiar python 3 usa utf 8 por defecto por lo que esto rara vez se necesita hoy en día pero puedes encontrarlo en código heredado directivas para verificadores de tipos los verificadores de tipos como mypy respetan comentarios en línea especiales x type ignore result some_function type ignore return value copiar estos suprimen errores de tipos específicos sin cambiar el comportamiento en tiempo de ejecución consulta el capítulo variables de python para más información sobre cómo python maneja los tipos buenas prácticas para comentarios seguir estas convenciones hará que tus comentarios sean genuinamente útiles práctica buen ejemplo evita explica el por qué no el qué cache result to avoid redundant api calls set x to 5 mantén los comentarios actualizados actualiza el comentario cuando cambies el código dejar comentarios obsoletos que contradigan el código usa oraciones completas skip empty lines before processing skip empty un espacio después de this is correct this has no space evita comentarios obvios no se necesita comentario x x 1 add 1 to x pep 8 la guía de estilo oficial de python recomienda los comentarios en línea deben estar separados de la instrucción por al menos dos espacios cada comentario en línea debe comenzar con almohadilla luego un espacio los comentarios de bloque que se aplican al código que sigue deben tener la misma sangría que ese código def apply_tax price tax_rate tax rate is expressed as a decimal e g 0 07 for 7 prices must be non negative validation happens upstream tax price tax_rate return price tax total including tax copiar errores comunes que debes evitar 1 dejar comentarios todo sin rastrearlos todo handle the case where the file does not exist data open data txt read copiar los todo son útiles durante el desarrollo pero deben estar vinculados a un sistema de seguimiento de incidencias no dejarse indefinidamente en código de producción 2 comentar bloques grandes en lugar de eliminarlos el control de versiones git preserva el historial no es necesario mantener código comentado para la posteridad elimínalo y usa git log si alguna vez necesitas recuperarlo 3 estilo inconsistente la mezcla de comment comment y comment en el mismo archivo hace que la base de código parezca desatendida acuerda un estilo y aplícalo de forma consistente resumen tipo de comentario sintaxis usar para una línea text notas en línea encabezados de sección multilínea líneas consecutivas con explicaciones extensas docstring text después de def class documentación de la api pública shebang usr bin env python3 punto de entrada de scripts unix codificación coding utf 8 archivos fuente que no usan utf 8 ignorar tipo type ignore suprimir errores de mypy los comentarios son una herramienta ligera que aportan valor cada vez que otro desarrollador o tú mismo en el futuro lee tu código para profundizar en temas relacionados consulta sintaxis de python y variables de python práctica práctica which of the following are ways to add comments in python code according to w3docs com which of the following are ways to add comments in python code according to w3docs com using using the symbol before the comment using before the comment using triple quotes before and after the comment or writing a comment in a separate line without any symbol before it comprobar was this page helpful yes no previous sintaxis de python next variables en python on this page comentarios de una línea comentarios multilínea docstrings comentarios de documentación estructurada comentar código durante la depuración directivas de comentarios especiales buenas prácticas para comentarios errores comunes que debes evitar resumen práctica w3docs tutoriales ejemplos ejercicios fragmentos y cuestionarios gratuitos para la web desde 2014 libros aprender html aprender css aprender javascript aprender git aprender java aprender php aprender python práctica ejercicios cuestionarios editor try it herramientas html editor password generator html encoder code diff json beautifier empresa acerca de contacto política de privacidad idioma english deutsch русский français español português italiano 2026 w3docs todos los derechos reservados hecho para desarrolladores
|
