Using literate programming to teach good programming practices

Shum, Stephen; Cook, Curtis R.

doi:10.1145/191029.191059

Cited by 14 publications

(6 citation statements)

References 9 publications

Supporting

Mentioning

Contrasting

Order By: Relevance

“…It allows the programmer to develop very sophisticated explanations which break up the standard program ordering and interleave it with TeX or troff documentation commands (the source program and document are derived by programs called 'tangle' and 'weave'). Although it has been used in a teaching context [ [7]], it is too complex for introductory programming courses as it adds an extra layer of complexity in the programming task.…”

Section: Literate Programmingmentioning

confidence: 99%

AnnAnn and AnnAnn.Net: Tools for Teaching Programming

Hooper¹,

Carr²,

Davis³

et al. 2007

JCP

View full text Add to dashboard Cite

It is difficult for a student to learn about programs and to understand the rational that went into the development of the parts that led to the whole. Tools for explaining this essentially dynamic process are limited and typically static in nature, making it difficult for students to understand how it was developed, or where to start. This paper presents AnnAnn.Net, an animated code annotator which makes it possible to present the incremental development of code to large groups or for self study. The tool is designed for ease of use by both lecturers and students. The implementation and the ration for which are described in detail. The design of the system is underpinned by a sound pedagogical approach and these are discussed, along with the educational benefits of this approach are examined.

show abstract

Section: Literate Programmingmentioning

confidence: 99%

AnnAnn and AnnAnn.Net: Tools for Teaching Programming

Hooper¹,

Carr²,

Davis³

et al. 2007

JCP

View full text Add to dashboard Cite

show abstract

“…Literate programming concepts [Knuth 1984;Shum and Cook 2002] focus on integrating informal descriptions of the program's functions (perhaps the documentation) with the formality of programming language instructions. A comprehensive review of literate programming can be found at http://www.literateprogramming.com.…”

Section: Literate Programmingmentioning

confidence: 99%

Designing and explaining programs with a literate pseudocode

Roy

2006

J. Educ. Resour. Comput.

View full text Add to dashboard Cite

Designing and explaining programs are often difficult tasks, especially when novices are involved. It also concerns more experienced programmers when complex algorithms need to be carefully explained and documented as part of software development.Good practice suggests that code and documentation be tightly coupled; but there are only a few support tools specifically targeted at novices that require this as an integral part of the programming process. We propose a new tool design with this objective in mind: P-Coder gives a flexible descriptive view of the program via pseudocode notation within a graphical tree-structured model, from which the complete algorithm can be specified to retain the informal description integrated with the final code. Thus the code meets some of the key requirements for realizing a literate program

show abstract

“…Software engineers advocate literate programming because it eases the effort needed to update the software documentation and it makes the source more comprehensible for maintenance programmers. In addition, it preserves the connection between the code and the documentation (Sametinger and Pomberger 1992;Ramsey and Marceau 1991;Cordes and Brown 1991), although its applications are not merely limited to software documentation (Shum and Cook 1994;Ruys and Brinksma 1998).…”

Section: Introductionmentioning

confidence: 99%

Rethinking Literate Programming in Statistics

Haghish

2016

The Stata Journal: Promoting communications on statistics and S

View full text Add to dashboard Cite

Literate programming is becoming increasingly trendy for data analysis because it allows the generation of dynamic-analysis reports for communicating data analysis and eliminates untraceable human errors in analysis reports. Traditionally, literate programming includes separate processes for compiling the code and preparing the documentation. While this workflow might be satisfactory for software documentation, it is not ideal for writing statistical analysis reports. Instead, these processes should run in parallel. In this article, I introduce the weaver package, which examines this idea by creating a new log system in HTML or LATEX that can be used simultaneously with the Stata log system. The new log system provides many features that the Stata log system lacks; for example, it can render mathematical notations, insert figures, create publication-ready dynamic tables, and style text, and it includes a built-in syntax highlighter. The weaver package also produces dynamic PDF documents by converting the HTML log to PDF or by typesetting the LATEX log and thus provides a real-time preview of the document without recompiling the code. I also discuss potential applications of the weaver package.

show abstract

Using literate programming to teach good programming practices

Cited by 14 publications

References 9 publications

AnnAnn and AnnAnn.Net: Tools for Teaching Programming

AnnAnn and AnnAnn.Net: Tools for Teaching Programming

Designing and explaining programs with a literate pseudocode

Rethinking Literate Programming in Statistics

Contact Info

Product

Resources

About