Anda di halaman 1dari 4

Los comentarios son una característica fundamental de un lenguaje programación

pues permiten a desarrollador dejar una gran variedad de mensajes en el código


fuente como: notas, recordatorios, ideas, aclaraciones, explicaciones, etc. que
sirven como referencia para sí mismo o para cualquiera que lea ese código en el
futuro.

Sin embargo no todos los comentarios son buenos, muchos de ellos pueden llegar
a ser redundantes o inexactos, y producen exactamente el efecto contrario: el
programador tarda más tiempo en entender el código.

“Indeed, the ratio of time spent reading versus writing is well over 10 to 1. We are
constantly reading old code as part of the effort to write new code. … [Therefore,]
making it easy to read makes it easier to write.”
― Robert C. Martin, Clean Code: A Handbook of Agile Software Craftsmanship

Escribir comentarios correctos en la situación adecuada es una habilidad por sí


misma que debemos adquirir para ser mejores programadores, la siguiente es una
serie de recomendaciones sobre cuando escribir un comentario y cuando es mejor
evitarlos.

Esto no es una verdad absoluta que deba respetarse el 100% del tiempo, más
bien debe usarse como una guía, aplica tu intuición y experiencia para obtener los
mejores resultados.

Notación
Durante los siguientes ejemplos usaré dos colores distintos para hacer notar la
diferencia entre código con malos comentarios y el código recomendado.

Horrible color, indica que los comentarios no son buenos.

https://www.enrique7mc.com/2017/03/cuando-debo-comentar-mi-codigo/
Pasar a un árbol

1. El programador olvida colocar comentario en funciones


Perder demasiado tiempo en entender una función

2. Muchas veces cometan parte del código que no funciona


Daña la legibilidad del código

3. Al realizar un cambio en el código no especifica cuando fue la modificación


No saber si el código sigue en funcionamiento o si necesita una nueva modificación

4. Colocar comentarios innecesarios


Llenar de comentario innecesarios afecta en el tiempo de lectura del código

5. Comentarios demasiado largos


Muchos de los programadores deciden pasar de ellos

6. La descripción de código mucha veces es ilegible


No llegan comentar una idea precisa que realiza en el código

7. No coloca la fecha de creación del código


No sabes cuándo fue creado y si necesita mantenimiento el código y si soportara este
cambio

8. Al modificar el código fuente, olvidan en colocar el número de modificaciones que se a


realizado en esta misma
No saber si el código a pasado por n modificaciones por errores y si el correcto en la
reutilización mismo

9. No realizar un mantenimiento a los comentarios


La parte del código realiza cosas diferentes a lo que esta comentado

10. No borrar los comentarios de funciones que fueron editadas o eliminadas


Crear confusión en la lectura del código

Concluir con que tipo de métodos de estudio y detodos de investos de investigación.

Dar tipo definición derespecto al problema de cada tipo.

Inductiva

Explorativa
3plan de proyecto

Problema:

Falta de comentarios en el código fuente

Objetivo general:

 Identificar los diferentes

Objetivos específicos:

Actividades:

 Realizar estudio exploratorio


 Realizar una revisión de literatura
 Recolectar datos adquiridos del estudio exploratorio
 Realizar una investigación documental
 Recolección de datos de investigación
 Clasificación de datos relevantes e irrelevantes
 Aplicar la encuesta
 Tabular datos de encuesta
 Comparación de datos de la encuesta contra los de la investigación científica

El tipo de método que nos parece correcto utilizar es:

Método lógico inductivo:

Procedimiento que parte de conocimientos particulares para llegar a una conclusión


generalizada. Este razonamiento aplicado al método científico permite llegar a formular
leyes científicas a partir de la observación y postulación de hipótesis. ¨ Se puede realizar la
comprobación y demostración de leyes ya postuladas. ¨

Procedimiento:

Observación: Observación de un fenómeno natural y búsqueda de la explicación.

Hipótesis: Postulado de una explicación, que puede ser la respuesta al hecho de que se dé
el fenómeno.

Investigación: Se realiza una comprobación de la hipótesis con varios casos diferentes que
lleven al mismo resultado.

Conclusión: Si la hipótesis funciona para varios casos, entonces funciona para todos.
Justificación del tipo de estudio y metofo de investigacion

El estudio exploratorio fue elegido ya que se adapta a nuestra investigación ya que el


problema que se plantea en esta investigación no ha sido estudiado como es debido lo que
provoca que sobresalgan algunas dudas nos va ayudar a relacionarnos con nuestro problema
que es “la Complejidad en el paradigma de programación orientada a objetos” y vamos a
identificar los diferentes tipos de factores que influyen en el problema planteado.

El método que se va a utilizar es el método lógico inductivo ya que vamos a obtener


información particular y vamos a generar la información requerida, esto se lo obtiene a
través de la observación y por medio de una postulación de una hipotesis y así poder
reconocer los factores que se encuentran asociados al problema planteado

Anda mungkin juga menyukai