Literate programming and documentation reuse
نویسندگان
چکیده
Object-oriented programming has brought many advantages to the software engineering community. The reuse of existing software components and application frameworks can improve the productivity in software development considerably. The same object-oriented techniques, i.e., inheritance and information hiding, that ease reusing software, can be applied to documentation and thus, enable its reuse. One can document each software component{ regardless of what a component is{from scratch. This leads to multiple documentation of features that are multiply reused. One can also describe a component's di erences to other components. This seems logical for the systems documentation of object-oriented software. However, as will be shown, this kind of reuse can not only be applied to source-code related documentation, but also to documentation, where there is no source code involved at all, e.g., user documentation. In this paper we describe the concepts for documentation reuse, how these concepts can be realized with a literate programming tool, and the application of documentation reuse.
منابع مشابه
Analysis of Literate Programs from the Viewpoint of Reuse
Donald Knuth created the WEB system for literate programming when he wrote the second version of TEX, a book-quality formatting system. Levy later created CWEB, which is based on Knuth’s WEB using the C programming language and supporting development using the C and C++ programming languages. Krommes’ FWEB is based on CWEB and supports several programming languages. We analyze some parts of the...
متن کاملDocumentation Inheritance in Literate Programs
Object-oriented programming has resulted in the reuse of class libraries and application frameworks. This can considerably improve the productivity in software development. Black-box reuse boosts productivity more than white-box reuse. However, white-box reuse is the usual means of dealing with common parts in di erent applications, assuming that the same developers are building these applicati...
متن کاملTowards Modern Literate Programming
Literate programming was invented by Donald Knuth as a technique for improved documentation of program understanding. It involves writing code and documentation in a single source document, ordered for comprehension by humans rather than computers. Despite its ability to produce software of higher quality and maintainability, the technique is not widely used. In this report, we present a compre...
متن کاملLiterate Programming in Forth
We look at Donald Knuth's concept of \Literate Programming," investigating exactly what it is and how it is used to assist conventional programmers. We then ask what lessons we can learn from this idea and if it is possible to apply them to Forth. We look at the alterations needed to the system and/or Forth to allow us to take advantage of this system. Indeed do we obtain all of the advantages ...
متن کاملIt Ain't What You View, But The Way That You View It: documenting spreadsheets with Excelsior, semantic wikis, and literate programming
I describe preliminary experiments in documenting Excelsior versions of spreadsheets using semantic wikis and literate programming. The objective is to create well-structured and comprehensive documentation, easy to use by those unfamiliar with the spreadsheets documented. I discuss why so much documentation is hard to use, and briefly explain semantic wikis and literate programming; although p...
متن کامل