Duda comentarios tarea

[vvialbarros]

Prerrequisitos

(Marcar colocando una X entre los corchetes los ítems que ya hiciste, así: "[X]")

• [X] Leí las reglas del foro (https://github.com/IIC2233/Syllabus/wiki/3.-Reglas-del-foro-(issues)).
• [X] Revisé el compilado de dudas de la tarea y no encontré una issue similar a la mía (click aquí para ir al compilado).
• [X] Mi duda no se trata sobre una librería o built-in, ya que eso se pregunta en la issue creada para ello (click aquí para ir a esa issue).
• [X] De ser necesario, colocaré código simple que permita explicar mi problema o duda, ya que compartir código de esta evaluación puede ser considerado una falta a la ética.

Duda

Es necesario explicar el código de las funciones de dccultivo.py (Por ejemplo decir: este contador sirve para contar cuantas veces sucede cierta cosa o este for sirve para buscar tal cosa)? Porque en el Readme dice que es recomendado hacer eso pero en la distribución de puntajes dice que esa parte de la tarea será revisada únicamente a través de testcases (Los items que corresponden a esa parte de la tarea no están con color amarillo), por eso me surgió la duda si es obligación explicar el código de las funciones a pesar de que no serán revisados por un ayudante ya que como dice en la distribucion de puntajes, serán revisados únicamente a través de tests.

[3rdPix]

Hola @vvialbarros !

No es necesario ni obligatorio escribir los comentarios. Son una herramienta para que quien sea que lea el código pueda seguir el funcionamiento entendiendo bien qué hace cada cosa. Como tu dices, para el caso de los tests automatizados ningún ayudante leerá ese código.

Como consejo personal, siempre crea comentarios que le puedan servir a tu yo del futuro, que nunca sabes cuándo podrías necesitar revisitar código que has escrito antes para reutilizarlo. :D