No deberías explicar la función de impresión. Cualquiera que necesite saber qué está haciendo su código debe saber qué hace la función de impresión. Si su función de impresión es sys.sysoutln (mensaje, fin = ”\ n \ l”, foo = Verdadero, barra = ”HN_BAR0 ″), tal vez debería documentarlo. Ya sea que use impresión o impresiones, realmente no importa allí.
La documentación del código tiene por objeto aclarar cosas que no son evidentes de inmediato. Documentar cada declaración if, else, while e print solo hace que sea más difícil para la persona que quiere saber cuál es la función que escribió hace 5 años para poder solucionar un problema con un nuevo esquema de entrada … o lo que sea.
Y la semántica solo importa en la medida en que se interpretan correctamente. “Imprimir”, “imprimir” … nadie está calificando su gramática u ortografía. Solo quieren saber qué se supone que debe hacer su código.
- Cómo arreglar un servicio de cola de impresión que no se está ejecutando
- ¿Cuál es la mejor manera de imprimir un calendario?
- ¿Qué hace que un chorro láser deje de imprimir en gris e imprima en negro?
- ¿Cuál es el tamaño máximo posible para una imagen impresa de 1920 x 1080 o un póster que mantenga la calidad?
- ¿Qué es un buen servicio de impresión barato en Londres?
