支持分析设计的javadoc扩展及工具实现

论文摘要

本文主要从软件维护过程中存在的代码与文档不一致、从而带来大量维护成本的问题入手,从多个方面深入分析了自文档技术的理论基础和实际意义。提出了一种基于“支持分析设计的javadoc扩展”的解决方案,即由编写程序代码的开发人员在Java源文件注释中加入本文给出的自定义标记和对于维护有帮助的信息,之后维护人员运行本工具得到所需要的设计文档和分析文档。在实现上首先根据UML知识体系为软件开发人员提供自定义标记规范;其次利用javadoc提供的接口,抽取注释中的信息进行转化生成类图;第三在原有javadoc的输出格式基础上进行源代码一级的修改,抽取出分析类信息;最后将所有生成物分类输出,为软件维护人员提供设计文档和分析文档。该系统是一个功能相对完善、操作简单、使用方便的支持分析设计的软件工程自文档工具。

论文目录

• 提要
• 第一章 绪论
• 1.1 本文背景
• 1.1.1 目前软件维护过程中存在的问题
• 1.1.2 软件文档使用现状
• 1.1.3 产生问题的原因
• 1.1.4 软件工程领域的常用解决方案
• 1.2 研究现状
• 1.2.1 自文档技术简介
• 1.2.2 相关理论
• 1.2.3 自文档相关工具
• 1.2.4 自文档技术优缺点分析
• 1.3 本文工作
• 1.4 本文结构
• 第二章 javadoc 简介
• 2.1 javadoc简介
• 2.2 javadoc利弊分析
• 2.3 javadoc标记
• 2.4 javadoc运行
• 2.5 javadoc功能扩展
• 2.6 标准Doclet输出简介
• 2.6.1 标准Doclet输出页面
• 2.6.2 输出文档的组织方式
• 2.7 小结
• 第三章 系统概述
• 3.1 系统结构与功能
• 3.1.1 系统运行流程图
• 3.1.2 系统生成物
• 3.1.3 系统用户
• 3.1.4 自定义标记规范
• 3.1.5 UML类图生成模块
• 3.1.6 分析类抽取模块
• 3.2 系统特点
• 3.3 系统开发和运行环境
• 第四章 自定义标记规范的设计与实现
• 4.1 定义新标记
• 4.1.1 定义类图生成所需标记
• 4.1.2 定义分析文档生成所需标记
• 4.2 自定义标记的限定
• 4.3 小结
• 第五章 UML 类图生成模块的设计与实现
• 5.1 实现原理
• 5.2 利用docletAPI自定义doclet的步骤
• 5.3 关键数据结构定义及分析
• 5.4 类图生成部分的关键设计
• 5.5 分析类视图的生成
• 5.6 DOT文件生成以及格式转化
• 5.6.1 DOT语言简介
• 5.6.2 用DOT语言表示类图
• 5.6.3 DOT文件生成流程图
• 5.6.4 格式转化
• 5.7 小结
• 第六章 分析类抽取模块的设计与实现
• 6.1 实现原理
• 6.2 标准Doclet源码分析
• 6.3 标准Doclet运行流程分析
• 6.4 分析类抽取模块流程的设计与实现
• 6.5 分析类抽取生成器的设计与实现
• 6.6 小结
• 第七章 结论
• 参考文献
• 摘要
• Abstract
• 致谢