The Vicinity of Program Documentation Tools

Research output: Working paperResearch

124 Downloads (Pure)

Abstract

Program documentation plays a vital role in almost all programming processes.  Program documentation flows between separate tools of a modularized environment, and in between the components of an integrated development environment as well.  In this paper we discuss the flow of program documentation between program development tools.  In the central part of the paper we introduce a mapping of documentation flow between program development tools.  In addition we discuss a set of locally developed tools which is related to program documentation.  The use of test cases as examples in an interface documentation tool is a noteworthy and valuable contribution to the documentation flow.  As an additional contribution we identify several circular relationships which illustrate feedback of documentation to the program editor from other tools in the development environment.
Original languageEnglish
Place of PublicationInstitut for Datalogi, Aalborg Universitet
PublisherDepartment of Computer Science, Aalborg University
EditionTR 09-004
Number of pages10
Publication statusPublished - 2009

Fingerprint

Program documentation
Computer programming
Feedback

Keywords

  • program documentation
  • program examples

Cite this

Nørmark, K. (2009). The Vicinity of Program Documentation Tools. (TR 09-004 ed.) Institut for Datalogi, Aalborg Universitet: Department of Computer Science, Aalborg University.
Nørmark, Kurt. / The Vicinity of Program Documentation Tools. TR 09-004. ed. Institut for Datalogi, Aalborg Universitet : Department of Computer Science, Aalborg University, 2009.
@techreport{09a37bb0ef9811deb63d000ea68e967b,
title = "The Vicinity of Program Documentation Tools",
abstract = "Program documentation plays a vital role in almost all programming processes.  Program documentation flows between separate tools of a modularized environment, and in between the components of an integrated development environment as well.  In this paper we discuss the flow of program documentation between program development tools.  In the central part of the paper we introduce a mapping of documentation flow between program development tools.  In addition we discuss a set of locally developed tools which is related to program documentation.  The use of test cases as examples in an interface documentation tool is a noteworthy and valuable contribution to the documentation flow.  As an additional contribution we identify several circular relationships which illustrate feedback of documentation to the program editor from other tools in the development environment.",
keywords = "programdokumentation, programeksempler, program documentation, program examples",
author = "Kurt N{\o}rmark",
year = "2009",
language = "English",
publisher = "Department of Computer Science, Aalborg University",
edition = "TR 09-004",
type = "WorkingPaper",
institution = "Department of Computer Science, Aalborg University",

}

Nørmark, K 2009 'The Vicinity of Program Documentation Tools' TR 09-004 edn, Department of Computer Science, Aalborg University, Institut for Datalogi, Aalborg Universitet.

The Vicinity of Program Documentation Tools. / Nørmark, Kurt.

TR 09-004. ed. Institut for Datalogi, Aalborg Universitet : Department of Computer Science, Aalborg University, 2009.

Research output: Working paperResearch

TY - UNPB

T1 - The Vicinity of Program Documentation Tools

AU - Nørmark, Kurt

PY - 2009

Y1 - 2009

N2 - Program documentation plays a vital role in almost all programming processes.  Program documentation flows between separate tools of a modularized environment, and in between the components of an integrated development environment as well.  In this paper we discuss the flow of program documentation between program development tools.  In the central part of the paper we introduce a mapping of documentation flow between program development tools.  In addition we discuss a set of locally developed tools which is related to program documentation.  The use of test cases as examples in an interface documentation tool is a noteworthy and valuable contribution to the documentation flow.  As an additional contribution we identify several circular relationships which illustrate feedback of documentation to the program editor from other tools in the development environment.

AB - Program documentation plays a vital role in almost all programming processes.  Program documentation flows between separate tools of a modularized environment, and in between the components of an integrated development environment as well.  In this paper we discuss the flow of program documentation between program development tools.  In the central part of the paper we introduce a mapping of documentation flow between program development tools.  In addition we discuss a set of locally developed tools which is related to program documentation.  The use of test cases as examples in an interface documentation tool is a noteworthy and valuable contribution to the documentation flow.  As an additional contribution we identify several circular relationships which illustrate feedback of documentation to the program editor from other tools in the development environment.

KW - programdokumentation

KW - programeksempler

KW - program documentation

KW - program examples

M3 - Working paper

BT - The Vicinity of Program Documentation Tools

PB - Department of Computer Science, Aalborg University

CY - Institut for Datalogi, Aalborg Universitet

ER -

Nørmark K. The Vicinity of Program Documentation Tools. TR 09-004 ed. Institut for Datalogi, Aalborg Universitet: Department of Computer Science, Aalborg University. 2009.