5 tips para escribir un comentario que destaque

El personaje de comentarios en Matlab es ‘%’. Todo de
El % hasta el final de esa línea del programa se considera un
comentario.

Como Matlab solo tiene comentarios de una sola línea, para marcar una región completa como
Un comentario (llamado comentario de bloque) use el comentario de una sola línea y
otra vez.

De %
% Jims Matlab Código
De %
% Este es un comentario en bloque
De %
% Este código no hace nada.
De %
% O
%{una multiline %}
algún código
%{
Código Jims Matlab
Este es un comentario en bloque
Este código no hace nada.
nada = 0; % no es muy útil comentario en línea
%}
algún código

El comentario de una sola línea es //. Todo de
El // al final de la línea es un comentario.

Para marcar una región completa como comentario, use /* para comenzar el comentario
y */ para terminar el comentario.

Esto se llama el «comentario del encabezado». Debería incluir
Toda la información definitoria sobre quién escribió el código, y por qué, y
cuándo y lo que debería hacer. (Ver comentario del encabezado a continuación)

Esto se llama encabezado de funciones y proporciona información sobre
El propósito de este «subcomponente» del programa.

Cuándo y si solo hay una función en un archivo, el
El encabezado de la función y los comentarios del encabezado de archivo deben fusionarse
en un solo comentario. (Ver encabezado de función a continuación)

Cualquier código «complicado» donde no sea inmediatamente obvio lo que
están tratando de lograr, deben tener comentarios justo encima o en
la misma línea con él.

Los comentarios deben ser descripciones útiles de alto nivel de lo que el
El programa está haciendo. No deberían reafirmar algo que sea «obvio».
Mediante el uso de nombres de variables apropiados, gran parte de un programa puede
Sea (casi) tan fácil de leer como el inglés.

¿Qué información contiene un comentario?

Los comentarios sirven como una forma adicional de documentación para su código fuente. Por lo tanto, el propósito general de ellos es informar a otros [incluido su yo futuro] de por qué alguna funcionalidad en el código se implementa de cierta manera, pero hay varias formas diferentes de implementar comentarios para lograr este objetivo.

Los comentarios en línea llegan al final de una línea de código. Hay dos razones principales para usar un comentario en línea:

#1 Si se ha definido una variable, pero la razón para usar un objeto específico no está claro, puede usar un comentario en línea para justificar su decisión.

Age = 18 # La edad legal para beber en el Reino Unido.

#2 Otro buen uso de un comentario en línea es reducir la ambigüedad al proporcionar más contexto a lo que se está definiendo.

día = 3 # días en una semana rango de 0 (lun) Altura (Sun) = 1.75 # La altura se da en metros

También puede ver algunas bases de código que usan comentarios para especificar el tipo de datos de una variable.

La única razón por la que hice esto en mi proyecto fue que estaba usando una herramienta automatizada llamada Typechecks para validar los tipos de datos; supongo que esa es la razón por la que también puede ocurrir en otras bases de código.

La mayoría de las veces, no necesita especificar el tipo de datos porque es obvio a partir de la declaración de asignación.

El objetivo principal de un comentario es explicar por qué se ha implementado una pieza específica de cierta manera. Como sabe, hay varias formas de hacer las cosas para que una explicación brinde más información sobre las intenciones del programador.

¿Qué información debe llevar un comentario?

[Ed. Nota: Si bien nos tomamos un tiempo para descansar durante las vacaciones y prepararnos para el próximo año, estamos volviendo a publicar nuestras diez mejores publicaciones para el año. Disfruta nuestro trabajo favorito este año y te veremos en 2022.]

El famoso profesor del MIT Hal Abelson dijo: «Se deben escribir programas para que las personas lean y solo, por cierto, para que las máquinas ejecuten». Si bien puede haber subestimado deliberadamente la importancia de ejecutar código, es acto en que los programas tienen dos audiencias muy diferentes. Los compiladores e intérpretes ignoran los comentarios y encuentran todos los programas sintácticamente correctos igualmente fáciles de entender. Los lectores humanos son muy diferentes. Encontramos algunos programas más difíciles de entender que otros, y buscamos comentarios para ayudarnos a darle sentido a ellos.

Si bien hay muchos recursos para ayudar a los programadores a escribir un mejor código, como libros y analizadores estáticos, hay pocos para escribir mejores comentarios. Si bien es fácil medir la cantidad de comentarios en un programa, es difícil medir la calidad y los dos no están necesariamente correlacionados. Un mal comentario es peor que ningún comentario. Como ha escrito Peter Vogel:

  • Escribir y luego mantener comentarios es un gasto.
  • Su compilador no verifica sus comentarios, por lo que no hay forma de determinar que los comentarios sean correctos.
  • Está, por otro lado, garantizado que la computadora está haciendo exactamente a qué le está diciendo su código.

Si bien todos estos puntos son ciertos, sería un error ir al otro extremo y nunca escribir comentarios. Aquí hay algunas reglas para ayudarlo a lograr un medio feliz:

Regla 3: Si no puede escribir un comentario claro, puede haber un problema con el código.

¿Qué tipo de información contiene un comentario de texto?

Para analizar los comentarios en el texto, se ideó un esquema de codificación (ver) basado en el modelo teórico de Hattie y Timperley (2007). Como este modelo se ha utilizado en estudios anteriores (por ejemplo, Arts, Jaspers y Joosten-ten Brinke 2016; Dirkx et al. 2019), se consideró un marco útil para analizar los comentarios de comentarios. La categoría «retroalimentación sobre la tarea» se dividió en tres subsectores: ediciones, comentarios evaluativos y consejos correctivos. Una revisión inicial de los datos sugirió que los comentarios relacionados con esta categoría fueron excepcionalmente variados y detallados y no se habrían capturado clasificando esta categoría de comentarios en un solo código. Por lo tanto, los subcodios permitieron una profundidad adicional al análisis.

Con el fin de garantizar que el esquema se pudiera utilizar para clasificar de manera consistente para clasificar comentarios, Lombard, Snyder-Duch y Campanella Bracken (2004) para la evaluación e informes de confiabilidades entre codificadores en los análisis de contenido. Después de la capacitación de codificadores en la que todos los autores y un asistente de investigación codificaron independientemente todos los comentarios sobre cuatro ensayos (dos de cada disciplina) contra una versión borrador del esquema, se llegó a un nivel apropiado de acuerdo. El esquema y las instrucciones de codificación se refinaron aún más, seguido de una etapa formal de codificación piloto donde 30 comentarios seleccionados al azar fueron codificados independientemente por el primer autor y el asistente de investigación. Se obtuvo un coeficiente Alpha (Hayes y Krippendorff 2007) de Krippendorff de .83, que se considera un nivel aceptable de confiabilidad en la mayoría de las situaciones (Lombard, Snyder-Duch y Campanella Bracken 2004). Se discutieron aclaraciones para cualquier discrepancia y se acordaron cambios. Los comentarios codificados durante la capacitación y las etapas piloto no se incluyeron en la muestra final de comentarios que se analizaron.

Durante la etapa de verificación de confiabilidad formal, el primer autor y el asistente de investigación se seleccionaron al azar el 10% de los comentarios totales (n = 212) para ser codificados independientemente. Posteriormente, el asistente de investigación codificó todos los comentarios restantes.

Para evaluar las características lingüísticas de los comentarios en el texto, utilizamos el software de análisis de texto de la investigación lingüística y el recuento de palabras (LIWC) (Pennebaker et al. 2015). LIWC devuelve información básica sobre extractos de texto (por ejemplo, el número de palabras, el número de verbos, etc.), así como el análisis del porcentaje de palabras en un extracto de texto que cae en una gama de diferentes categorías lingüísticas. Para nuestro análisis, seleccionamos categorías lingüísticas que se alinean con aspectos de la práctica de retroalimentación que se cree que tienen un impacto potencial en los estudiantes.

Henderson et al. (2019) describen las diferentes formas en que la retroalimentación puede tener un impacto en los estudiantes, y las utilizamos para organizar nuestro análisis lingüístico exploratorio (ver). Argumentan que la información de retroalimentación puede tener impactos relacionales, influyendo en las percepciones de credibilidad, confianza, seguridad y amenaza percibidas de los estudiantes. Estos impactos pueden influir en el compromiso de los estudiantes con la retroalimentación (por ejemplo, la búsqueda de comentarios, la interpretación y la acción). Seleccionamos cuatro categorías lingüísticas de la alineación de LIWC con los impactos relacionales de la retroalimentación: pronombres personales, pronombres impersonales, palabras asociadas con poder y palabras asociadas con afiliación ().

¿Qué se debe tener en cuenta para realizar un comentario?

Cualquier persona con acceso al editor o comentarista al Doc Google puede crear un comentario.

Hay varias formas de agregar un comentario, pero la forma más fácil es seleccionar el texto que desea comentar, luego haga clic en el botón que aparece en el lado derecho de la pantalla.

El cuadro de comentarios se abre y puede escribir su mensaje.

Si desea asegurarse de que una persona específica vea su comentario, puede etiquetarlos. Para etiquetar a alguien, escriba el símbolo @ y comience a escribir su dirección de correo electrónico. Luego seleccione de su lista de contactos.

Si etiqueta a alguien que aún no tiene acceso al documento, Google le pedirá que comparta el documento con ellos antes de publicar su comentario.

Cuando etiquetas a alguien, tienes la opción de asignarles el comentario. Asignar un comentario a alguien significa que serán responsables de marcarlo como completo.

Cuando haya terminado de escribir su comentario, haga clic en Comentar.

Una vez que se agrega un comentario, cualquier persona con comentarista o editor acceso al documento podrá verlo y dejar una respuesta.

Luego, escriba su respuesta. Cuando haya terminado, haga clic en Responder.

Si cometió un error al escribir un comentario, puede hacer clic en los tres puntos en la esquina superior derecha para editar o eliminar su comentario. Tenga en cuenta que eliminar un comentario de esta manera es permanente.

Si hace clic en los tres puntos junto al primer comentario en un hilo, tiene la opción de vincular a este comentario.

Se abre un cuadro de diálogo que le permite copiar el enlace para que pueda compartirlo con otra persona. Esto es útil en documentos largos con muchos comentarios, ya que el enlace apunta directamente a la parte relevante del documento e incluso abre el hilo de comentarios.

¿Cuáles son las partes de un comentario de texto?

  • El documento en general (no está vinculado a ningún pasaje en particular, por ejemplo, los antecedentes del autor, el estilo y la estructura del documento, su contexto histórico, etc.)

Una vez que haga clic en algún lugar del texto del documento, los globos de comentarios también aparecerán al final de todas las oraciones que tienen comentarios a nivel de oración. Por ejemplo, el párrafo #42 a continuación tiene un total de 4 comentarios de nivel de párrafo (2 niveles de oración y 2 niveles de párrafo):

Mousing sobre el documento destaca la oración en la que se encuentra en azul y describe el párrafo en gris.

Los pasajes de documento y los comentarios sobre ellos están sincronizados; Solenciar haciendo clic en un pasaje de documento desplaza la pantalla para resaltar y mostrar cualquier comentario relacionado. Del mismo modo, hacer clic en un encabezado de comentarios o comentarios desplazará el documento para resaltar y mostrar el pasaje correspondiente.

  • El documento en general (no está vinculado a ningún pasaje en particular, por ejemplo, los antecedentes del autor, el estilo y la estructura del documento, su contexto histórico, etc.)
  • «Resumen del comentario»: una descripción requerida de su comentario; Los puntos esenciales que quieres hacer. Una o dos oraciones comunicativas funcionan mejor.
  • «Comentario completo» – opcional; le permite desarrollar su línea de resumen con argumentos y perspectivas más detalladas, citas, datos, etc.
  • Modo completo versus resúmenes: cuando carga por primera vez un documento, el comercio de ahora muestra todos los comentarios en modo completo (tanto el resumen como los campos de comentarios completos). Pero si no desea leer todos los comentarios en su totalidad de inmediato, elija «resúmenes» para ver el campo de resumen para cada comentario; Esto te permite esconderse rápidamente de lo que la gente está hablando. La captura de pantalla anterior muestra comentarios en modo resumen.

    ¿Qué es un comentario de un texto?

    Si desea que sus comentarios de texto sean buenos y obtenga una muy buena calificación en el próximo examen de selectividad, debe seguir este método.

    • Paso 1: Haga una lectura cuidadosa del texto literario que tenemos ante nosotros. Esta lectura es la fase anterior al comentario, es decir, antes de comenzar el ejercicio, es necesario leer el texto con cuidado y claramente lo que se dice en él, así como el significado de todas sus palabras y expresiones (recomendamos tener un diccionario cerca de la posible búsqueda de palabras desconocidas).
    • Paso 2: Localice el fragmento o el trabajo, es decir, enmarcarlo en un contexto y tiempo, saber quién es el autor que lo ha escrito (lo que nos dará una pista muy clara de sus características) y finalmente, si es así. Un breve fragmento, para saber a qué trabajo pertenece. .
    • Paso 3: Debemos especificar el género del texto literario y la forma de expresión literaria. Es decir, si el texto pertenece a la letra, al teatro, a la narración, etc. Por ejemplo, si el texto está escrito en verso, será hora de hacer una descripción métrica, con la medida de los versos , su rima, las estrofas, el nombre del poema, etc. Si, por el contrario, el texto es narrativo, debemos llevar a cabo un análisis de los diferentes elementos, como el carácter del narrador, la acción realizada, realizada, Los personajes que aparecen, el marco narrativo, etc.
    • Paso 4: Analizaremos el contenido. En esta fase analizaremos el contenido lo más profundamente posible. Para esto, debemos prestar atención y analizar cuidadosamente aspectos como la estructura de contenido, el tema, las ideas centrales del texto, las ideas secundarias, etc.
    • Paso 5: Analizaremos el formulario. En esta fase, especificaremos cómo se refleja el contenido en el formulario. Por ejemplo: si el autor ha querido expresar o transmitir desconcierto, miedo, sorpresa, alegría, etc.
    • Paso 6: Conclusión. Es la parte final de nuestro comentario de texto. Aquí, resumiremos los diferentes aspectos que hemos tratado en el comentario, para dar una idea breve y conjunta de lo que hemos expuesto. La interpretación que hacemos en esta conclusión será válida siempre que esté de acuerdo con todos los puntos previamente expuestos en el comentario de texto. En esta conclusión, también podemos incorporar nuestra impresión personal, nuestra satisfacción con la lectura, los sentimientos que nos ha transmitido, la evaluación de su efectividad, etc.

    Hacer un buen comentario de texto, incluso si tenemos un paso a paso muy detallado, también depende de la práctica, del hábito de lectura que tenemos (cuanto mayor sea el número de lecturas detrás de nosotros, mayor es la capacidad de análisis y síntesis literaria. tendrá), en la dificultad del texto del que nos ponen delante (no es lo mismo analizar «letras marroquíes» de Cadalso que una poesía de Góngora), etc.

    Por lo tanto, lo alentamos de la literatura actual, que no se bloquee frente a este tipo de ejercicios, porque quizás en el futuro será editor o editor de una editorial importante o simplemente le gusta leer y libros tanto que decida Para hacer un blog literario en el que pongas cientos de reseñas. Las revisiones literarias son comentarios sobre obras completas. Pero hablaremos de esto en otro artículo.

    El contenido del artículo se adhiere a nuestros principios de ética editorial. ¡Para informar un error, haga clic aquí!.

    Artículos Relacionados:

    Más posts relacionados:

    Deja una respuesta

    Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *