Literate Haskell (.lhs) y Haddock

Question

Por el momento sólo estoy usando eglefino pero después de ver algunos ejemplos muy interesantes (por ejemplo, este GIST ) de leer y escribir Haskell, estoy interesado en tratar a cabo en un proyecto.

Las preguntas que tengo, son los siguientes:

• Lo que se escribe como comentarios Haddock y lo que se escribe en la parte leer y escribir?

• ¿Cómo se cambia la escala de programación literaria a varios archivos? ¿Puede mi punto cualquiera a un ejemplo donde se utiliza la programación ilustrada en un paquete con múltiples módulos? ¿Cuál es su experiencia en el uso de programación literaria en paquetes más grandes?

• ¿Qué sabor (rebajas, látex, ...) se prefiere de leer y escribir Haskell?

• ¿Por qué estás programando en Haskell leer y escribir o con sabor de vainilla Haskell? ¿Está programando en ambos estilos y si es así ¿por qué?

• ¿Prefiere al estilo de bloque (\begin{code}) o al estilo de Aves (>)? ¿Por qué?

Answer 1

Yo solía escribir una gran cantidad de programas alfabetizados .

  

Lo que se escribe como comentarios Haddock y lo que se escribe en la parte leer y escribir?

La API externa documentación entra en los comentarios Haddock. Todo lo demás entra en la parte leer y escribir. "Todo lo demás" podría incluir:

• invariantes internas de las estructuras de datos
• ¿Por qué que está haciendo las cosas de esta manera
• Lo que el diseño del código es
• ¿Por qué se eligió este diseño, lo que otros diseños fueron juzgados y hallados faltos

  

¿Cómo se cambia la escala de programación literaria a varios archivos?

De la misma manera se cambia la escala de un documento LaTeX grande para varios archivos:. Un archivo por cada módulo, a continuación, un archivo gigante que \includes a todos

  

me puede punto cualquiera a un ejemplo donde se utiliza la programación ilustrada en un paquete con múltiples módulos?

No es Haskell, pero el href="http://www.cminusminus.org/qc--.html" rel="noreferrer"> C-- compilador es un gran programa funcional

  

¿Cuál es su experiencia en el uso de programación literaria en paquetes más grandes?

Programación literaria funciona muy bien para la documentación de los módulos complicadas, difíciles o complejos. Para la mayoría de los módulos simples, la documentación API externa (por ejemplo, eglefino) es suficiente. Y ningún programa leer y escribir es realmente va a darle el panorama general de un diseño que incluye más de una docena de módulos. Para que usted necesita otras herramientas y técnicas.

  

¿Qué sabor (rebajas, látex, ...) se prefiere de leer y escribir Haskell?

Si usted está haciendo una inversión tan importante, sin duda me quedo con LaTeX sólo por la capacidad de las matemáticas, y el general mayor potencia de la herramienta.

  

¿Por qué estás programando en Haskell leer y escribir o plain vanilla Haskell? ¿Está programando en ambos estilos y si es así ¿por qué?

Mi Haskell códigos son casi siempre todo con sabor de vainilla, por dos razones:

• trabajo que con las personas mayores que tienen más experiencia Haskell, y han abandonado leer y escribir Haskell. Sólo los módulos muy antiguas de su sistema tienen alguna posibilidad de ser .lhs.

• En Haskell, programación literaria es una especie de superfluo. Una de las grandes ventajas de una herramienta de programación leer y escribir es que se libera de las restricciones que la definición del compilador o lenguaje podría poner en el orden en que aparece el código. Pero Haskell casi no tiene estas restricciones: no hay una definición antes de su uso, y para la definición de una función típica que tiene la opción de let vinculante o nombres auxiliares de unión where-(o ambos). Literate programación nunca fue sólo acerca de los comentarios de fantasía, y con "leer y escribir" Haskell eso es todo lo que se obtiene. No vale la pena la molestia.

  

¿Prefiere bloque de estilo (\ begin {code}) o al estilo de Aves (>)? ¿Por qué?

Yo prefiero fuertemente estilo de bloque:

• Es más o menos compatible con cualquier otro instrumento de programación leer y escribir en el planeta. (Pistas del pájaro son exclusivos de Haskell.)

• mi editor Copes mejor con estilo de bloque.

Answer 2

Si tiene intención de compartir programas en Internet, he encontrado una combinación de Haskell leer y escribir en el estilo de rebajas con mathjax a ser una gran combinación. El programa "Pandoc" está seriamente brillante para tomar este "rebajas" + izda a cualquier formato que desee, incluyendo PDF o HTML. Si usted le dice a Pandoc salida a HTML, puede utilizar la -mathjax (u otras banderas similares si se prefiere) para tener sus fórmulas matemáticas hacen de látex.

Cuando se utiliza este estilo, encuentro del estilo del pájaro que es preferible, ya que sólo es más fácil de leer para mí y parece encajar con el estilo de reducción del precio mejor.

La gran cosa sobre el uso Pandoc con reducción del precio es que se puede agregar citas a su código, fórmulas matemáticas, y tienen un formato realmente portátil. Se puede construir algo que se parece a un trabajo de investigación científica, pero es ejecutable y también puede ser enviado a blogs / wikis / sitios web.

Para darle un punto alternativo a Norman donde dice que la programación ilustrada es útil para el arreglo de código más claro, se podría argumentar que Haskell es lo suficientemente expresiva que los problemas a resolver con el código son realmente interesante y realmente se pueden beneficiar al estar rodeado con el texto explicativo. Pensar en un trabajo de investigación matemática. Los buenos papeles en las matemáticas puras tienen una gran cantidad de texto para explicar la motivación o de nivel superior interpretaciones de lo que significa la notación matemática. En un trabajo sobre las ecuaciones de Navier-Stokes, por ejemplo, sería super útil para rodear la notación de las ecuaciones con texto que explica cómo se relaciona con la conservación del momento de Newton.

En resumen, he tenido buen éxito con, y recomendar, usando el estilo de rebajas + LHS, signos de dólar a fórmulas matemáticas incrustar látex, estilo del pájaro, y Pandoc. Yo recomendaría la escritura de programas como si fueran artículos de investigación y tratar la Haskell como lo haría con expresiones matemáticas en un trabajo de investigación.