使用依赖关系图作为记录程序的支持

Proceedings. Second IEEE International Workshop on Source Code Analysis and Manipulation Pub Date : 2002-10-01 DOI:10.1109/SCAM.2002.1134114

Françoise Balmas

{"title":"使用依赖关系图作为记录程序的支持","authors":"Françoise Balmas","doi":"10.1109/SCAM.2002.1134114","DOIUrl":null,"url":null,"abstract":"In this paper we argue that source code is not the best support for commenting programs and we introduce dependence graphs as a better support since they offer different levels of abstraction and make visible objects that are not directly represented in the source code. We first introduce our tool to display dependence graphs, focusing on how different views of the same program can be built and tuned by grouping together nodes that are syntactically or conceptually related. We also show how these views make visible objects of the program that aren't accessible for comment in the source code while they can be, in our tool, richly documented through typed annotations. Then we review which kinds of units can be commented this way and discuss a typical way to apply our tool to document programs. Finally, we give strategies towards the automation of program documentation.","PeriodicalId":301735,"journal":{"name":"Proceedings. Second IEEE International Workshop on Source Code Analysis and Manipulation","volume":"35 1","pages":"0"},"PeriodicalIF":0.0000,"publicationDate":"2002-10-01","publicationTypes":"Journal Article","fieldsOfStudy":null,"isOpenAccess":false,"openAccessPdf":"","citationCount":"24","resultStr":"{\"title\":\"Using dependence graphs as a support to document programs\",\"authors\":\"Françoise Balmas\",\"doi\":\"10.1109/SCAM.2002.1134114\",\"DOIUrl\":null,\"url\":null,\"abstract\":\"In this paper we argue that source code is not the best support for commenting programs and we introduce dependence graphs as a better support since they offer different levels of abstraction and make visible objects that are not directly represented in the source code. We first introduce our tool to display dependence graphs, focusing on how different views of the same program can be built and tuned by grouping together nodes that are syntactically or conceptually related. We also show how these views make visible objects of the program that aren't accessible for comment in the source code while they can be, in our tool, richly documented through typed annotations. Then we review which kinds of units can be commented this way and discuss a typical way to apply our tool to document programs. Finally, we give strategies towards the automation of program documentation.\",\"PeriodicalId\":301735,\"journal\":{\"name\":\"Proceedings. Second IEEE International Workshop on Source Code Analysis and Manipulation\",\"volume\":\"35 1\",\"pages\":\"0\"},\"PeriodicalIF\":0.0000,\"publicationDate\":\"2002-10-01\",\"publicationTypes\":\"Journal Article\",\"fieldsOfStudy\":null,\"isOpenAccess\":false,\"openAccessPdf\":\"\",\"citationCount\":\"24\",\"resultStr\":null,\"platform\":\"Semanticscholar\",\"paperid\":null,\"PeriodicalName\":\"Proceedings. Second IEEE International Workshop on Source Code Analysis and Manipulation\",\"FirstCategoryId\":\"1085\",\"ListUrlMain\":\"https://doi.org/10.1109/SCAM.2002.1134114\",\"RegionNum\":0,\"RegionCategory\":null,\"ArticlePicture\":[],\"TitleCN\":null,\"AbstractTextCN\":null,\"PMCID\":null,\"EPubDate\":\"\",\"PubModel\":\"\",\"JCR\":\"\",\"JCRName\":\"\",\"Score\":null,\"Total\":0}","platform":"Semanticscholar","paperid":null,"PeriodicalName":"Proceedings. Second IEEE International Workshop on Source Code Analysis and Manipulation","FirstCategoryId":"1085","ListUrlMain":"https://doi.org/10.1109/SCAM.2002.1134114","RegionNum":0,"RegionCategory":null,"ArticlePicture":[],"TitleCN":null,"AbstractTextCN":null,"PMCID":null,"EPubDate":"","PubModel":"","JCR":"","JCRName":"","Score":null,"Total":0}

引用次数: 24

摘要

在本文中，我们认为源代码不是注释程序的最佳支持，我们引入依赖图作为更好的支持，因为它们提供了不同层次的抽象，并使源代码中没有直接表示的对象可见。我们首先介绍显示依赖关系图的工具，重点介绍如何通过将语法或概念上相关的节点分组在一起来构建和调整同一程序的不同视图。我们还展示了这些视图如何使程序的可见对象在源代码中无法进行注释，而在我们的工具中，它们可以通过类型化注释进行丰富的文档记录。然后，我们回顾了哪些类型的单元可以用这种方式进行注释，并讨论了将我们的工具应用于文档程序的典型方法。最后，给出了实现程序文档自动化的策略。

本文章由计算机程序翻译，如有差异，请以英文原文为准。

查看原文本刊更多论文

Using dependence graphs as a support to document programs

In this paper we argue that source code is not the best support for commenting programs and we introduce dependence graphs as a better support since they offer different levels of abstraction and make visible objects that are not directly represented in the source code. We first introduce our tool to display dependence graphs, focusing on how different views of the same program can be built and tuned by grouping together nodes that are syntactically or conceptually related. We also show how these views make visible objects of the program that aren't accessible for comment in the source code while they can be, in our tool, richly documented through typed annotations. Then we review which kinds of units can be commented this way and discuss a typical way to apply our tool to document programs. Finally, we give strategies towards the automation of program documentation.

求助全文

通过发布文献求助，成功后即可免费获取论文全文。去求助

来源期刊

Proceedings. Second IEEE International Workshop on Source Code Analysis and Manipulation

自引率

0.00%

发文量