Automating comments

Authors:
P.-N. Robillard
Affiliations:
Department of Electrical Engineering, Software Engineering Research Laboratory, Ecole Polytechnique of Montreal, C.P. 6079 Succ. A. Montreal, Qc. CANADA H3C 3A7
Venue:
ACM SIGPLAN Notices
Year:
1989

Citing 2
Cited 2

Schematic pseudocode for program constructs and its computer automation by SCHEMACODE

Communications of the ACM
Programming languages should NOT have comment statements

ACM SIGPLAN Notices

Enhancing program comprehension: formatting and documenting

ACM SIGPLAN Notices
TODO or to bug: exploring how task annotations play a role in the work practices of software developers

Proceedings of the 30th international conference on Software engineering

Quantified Score

Hi-index	0.00

Visualization

Abstract

This paper addresses the problem of source code documentation. Source code documentation has two components: the description of the statement and the description of the steps required to go from the specifications in natural language to programming language statements. We propose a model that provides a different mechanism for each form of documentation. A tool is used to implement and automate this approach. Results show that this approach provides a systematic and coherent mechanism for source code documentation. Productivity is increased and maintenance effort is greatly reduced.