Automating comments

Subscribe (Full Service)


	Search: The ACM Digital Library The Guide

	Feedback

Automating comments

Full text

Pdf (555 KB)

Source

ACM SIGPLAN Notices archive
Volume 24 , Issue 5 (May 1989) table of contents

Pages: 66 - 70

Year of Publication: 1989

ISSN:0362-1340

Author

P.-N. Robillard

Department of Electrical Engineering, Software Engineering Research Laboratory, Ecole Polytechnique of Montreal, C.P. 6079 Succ. A. Montreal, Qc. CANADA H3C 3A7

Publisher

ACM New York, NY, USA

Bibliometrics

Downloads (6 Weeks): 2, Downloads (12 Months): 19, Citation Count: 2

Additional Information:

abstract references cited by index terms collaborative colleagues

Tools and Actions:	Review this Article Save this Article to a Binder Display Formats: BibTeX EndNote ACM Ref

DOI Bookmark:	Use this link to bookmark this Article: http://doi.acm.org/10.1145/66068.66073 What is a DOI?

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.

REFERENCES

Note: OCR errors may be found in this Reference List extracted from the full text article. ACM has opted to expose the complete List rather than only correct and linked references.

	1	M. J. Kaelbling, Programming languages should NOT have comment statements, ACM SIGPLAN Notices, v.23 n.10, p.59-60, Oct. 1988 [doi>10.1145/51607.51609]
	2	[2] Robillard P.N., Coupal, D., Data on the Use of the Step-wise Refinement Approach. 6th Annual Pacific Northwest Conf. on Software Quality, Sept. 19-20, 1988, pp. 405-417.
	3	Pierre N. Robillard, Schematic pseudocode for program constructs and its computer automation by SCHEMACODE, Communications of the ACM, v.29 n.11, p.1072-1089, Nov. 1986 [doi>10.1145/7538.7541]
	4	[4] Bergland, G. D. A guided tour of program design methodologies, IEEE Computer, oct. 1981, pp. 13-37.

CITED BY 2

	Mouloud Arab, Enhancing program comprehension: formatting and documenting, ACM SIGPLAN Notices, v.27 n.2, p.37-46, Feb. 1992
	Margaret-Anne Storey , Jody Ryall , R. Ian Bull , Del Myers , Janice Singer, 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, May 10-18, 2008, Leipzig, Germany