¿Reglas de buenas prácticas para escribir LaTeX limpio?

¿Reglas de buenas prácticas para escribir LaTeX limpio?

¿Existen reglas de buenas prácticas para escribir LaTeX limpio? Algo así como PEP8 para Python. Ejemplos:

  • espacios o tabulaciones (no un troll);
  • cuántas columnas antes de ajustar (80 para Python compatible con PEP8);
  • algo sobre comentarios;
  • etc.

Respuesta1

La respuesta corta aquí es simple: "No, no existen reglas similares a PEP8 o similares".

Para una respuesta más larga, quizás valga la pena dividir las fuentes LaTeX en dos tipos:

  • Documentos (la mayor parte del trabajo para la mayoría de las personas)
  • Paquetes y otros 'códigos'

Por supuesto, existe cierta superposición, ya que es posible que sea necesario "hacer algo de codificación rápidamente" en un preámbulo, pero la "naturaleza" de un archivo fuente suele ser, en términos generales, uno u otro caso.

Para documentos, el número de autores quealguna vezVeamos que la fuente es pequeña: el objetivo clave es la salida tipográfica. Por lo tanto, realmente depende de los individuos involucrados cómo presentan sus aportes.

Para el 'código', se podrían argumentar a favor de resultados ligeramente diferentes, ya que existe al menos la posibilidad de una lectura/reutilización más amplia de las fuentes. Sin embargo, la experiencia práctica sugiere que en la mayoría de los paquetes sólo hay una persona que escribe el código, incluso para material de uso generalizado. Cuando hay excepciones, más obviamente el núcleo pero también cosas como beamero biblatex, el "tamaño del equipo" tiende a ser pequeño y normalmente es posible un acuerdo informal. (Por lo general, una persona ha comenzado las cosas para que se pueda acordar alguna posición basada en apegarse a lo que haya hecho). Aquí, por supuesto, podríamos usar el.dtx formato para el código, lo que llevaría a resultados de "comentarios" muy diferentes a los casos en los que la fuenteesel paquete (compare el kernel con etoolbox, por ejemplo).

El único lugar donde hay una guía de estilo para el código es paraexpl3: el equipo tieneescrito uno basado en la forma en que el código ha tendido hacia. Incluso allí, sin embargo, no tiene sentido que el código que no sigue estas reglas sea "malo": se trata mucho más de lacontenido.

Es importante recordar que TeX es un lenguaje de expansión de macros y eso hace que los 'verificadores' automáticos sean difíciles o imposibles de implementar: consulte ¿Guía de estilo automática para LaTeX?.

información relacionada