Recovering code to documentation links in OO systems
Recovering code to documentation links in OO systems
复制标题
将代码恢复到 OO 系统中的文档链接
DOI：
10.1109/wcre.1999.806954
复制
发表时间：
1999
期刊：
影响因子：
--
通讯作者：
E. Merlo
中科院分区：
文献类型：
--
作者：
G. Antoniol;G. Canfora;A. D. Lucia;E. Merlo
软件系统文档几乎总是用自然语言和自由文本非正式地表达。示例包括需求规范、设计文档、用户手册页面、系统开发日记、错误日志和相关维护报告。我们提出了一种方法来建立和维护源代码和自由文本文档之间的可追溯性链接。我们工作的一个前提是，程序员使用有意义的名称为程序的项目，如函数，变量，类型，类和方法。我们相信，程序员在编写代码时处理的应用程序领域知识通常由标识符的助记符捕获;因此，对这些助记符的分析可以帮助将高级概念与程序概念相关联，反之亦然。在本文中，该方法适用于软件编写的面向对象（OO）的语言，即C++，跟踪类手动部分。
Software system documentation is almost always expressed informally, in natural language and free text. Examples include requirement specifications, design documents, user manual pages, system development journals, error logs and related maintenance reports. We propose an approach to establish and maintain traceability links between the source code and free-text documents. A premise of our work is that programmers use meaningful names for program's items, such as functions, variables, types, classes and methods. We believe that the application domain knowledge that programmers process when writing the code is often captured by the mnemonics for identifiers; therefore, the analysis of these mnemonics can help to associate high-level concepts with program concepts, and vice versa. In this paper, the approach is applied to software written in an object-oriented (OO) language, namely C++, to trace classes to manual sections.