基于组件化的实时功能文档系统及方法技术方案

基于组件化的实时功能文档系统，包括配置文档格式组件和配置描述组件及模板的组件；配置文档格式组件用于通过配置生成不同人群可读性高的文档，根据不同系统功能生成不同格式的文档；和

【技术实现步骤摘要】
基于组件化的实时功能文档系统及方法


[0001]本专利技术涉及软件开发
，具体而言，涉及基于组件化的实时功能文档系统及方法
。

技术介绍

[0002]在实际开发过程中，开发人员需要维护大量的接口文档
、
系统功能文档等，这对于非开发人员来说可能会造成很大的沟通成本
。
为了解决这个问题，我们提出了一种基于组件化的系统实时功能文档解决方案
。
[0003]通过该方案，我们期望能够提高开发人员与非开发人员沟通文档效率，降低文档维护成本
。

技术实现思路

[0004]本申请实施例提供了基于组件化的实时功能文档系统及方法，在提高开发人员与非开发人员沟通文档效率，降低文档维护成本
。
通过组件化实现自动文档工具的设计和实现，可以在很大程度上减少项目的维护成本，提高开发效率
。
[0005]本专利技术提供了基于组件化的实时功能文档系统，包括配置文档格式组件和配置描述组件及模板的组件；
[0006]配置文档格式组件用于通过配置生成不同人群可读性高的文档，根据不同系统功能生成不同格式的文档；
[0007]和
/
或配置描述组件及模板的组件和自定义注解方式组件
。
[0008]优选地，文档模板还包括：
[0009]开发人员样式的接口文档
、
[0010]非开发人员样式的各种组件文档
、
[0011]开发人员样式的系统功能文档
>、
[0012]非开发人员样式的接口文档
、
[0013]非开发人员样式的各种组件文档
、
[0014]非开发人员样式的系统功能文档
、
[0015]系统概要文档
、
[0016]系统组件简要文档
、
[0017]系统组件详细文档
、
[0018]系统功能概要文档
、
[0019]和系统功能详细文档
。
[0020]本专利技术提供了基于组件化的实时功能文档系统的工作方法步骤一
、
设计
UML
设计图，包括接口文档
、
组件文档和生成文档工具等
。
步骤二
、
使用
Java Swing
框架实现组件化实现自动文档工具的功能
。
步骤三
、
编写
Java
程序实现配置文档格式组件和生成文档工具的功能
。
[0021]进一步地，
[0022]在步骤一中，接口文档：定义接口的各个方法
、
属性和参数，以及接口的版本号和声明时间；
[0023]组件文档：定义组件的接口
、
属性和方法，以及组件的版本号和声明时间；生成文档工具：定义生成文档工具的功能，以及生成不同类型文档的方法
。
[0024]进一步地，
[0025]在步骤一中，选择合适的文档格式：根据项目需求选择合适的文档格式，包括
HTML
和
XML
；
[0026]定义文档结构：根据
UML
设计图定义不同类型文档的结构，
[0027]生成文档模板：根据
UML
设计图生成不同类型文档的模板，包含文本
、
标签
、
注释
[0028]实现组件化：为组件的配置提供组件化支持，使得开发者可以自定义组件的样式
、
颜色
。
[0029]更进一步地，
[0030]步骤二中，引入所需的库：导入所需的
Java
库，如
Swing、JavaDoc
等
。
组件化：通过
Swing
框架实现组件化，定义组件的接口
、
属性和方法，以及组件的版本号和声明时间；
[0031]配置文档格式组件：实现配置文档格式组件的功能，包括选择合适的文档格式
、
定义文档结构
、
生成文档模板；
[0032]生成文档工具：实现生成文档工具的功能，包括解析
UML
设计图
、
生成不同类型文档
、
实现代码优化
。
[0033]进一步地，在步骤一中，导入
UML.XML
文件：根据
UML.XML
文件定义
UML
设计图；
[0034]定义
UML
设计图：根据
UML
设计图定义不同类型文档的
UML
结构；
[0035]生成
UML
设计图：根据
UML
设计图生成不同类型文档的数据结构
。
[0036]第三方面，本申请还提供了一种计算机可读存储介质，所述计算机可读存储介质存储有计算机程序，所述计算机程序被处理器执行时实现第二方面所述的方法
。
[0037]本申请实施例与现有技术相比存在的有益效果是：
[0038]1.
极大减轻开发人员维护系统文档的负担
。
[0039]2.
可以实时生成当前系统功能及接口相关文档方便各方人员
(
开发人员，客户经理，领导等
)
快速了解某个系统当前系统现状
。
较少各方人员之间的沟通成本
。
[0040]3.
能快速了解当前系统现状，有助于快速推广系统的新功能
。
及时应对快速变化的市场
。
具体实施方式
[0041]以下描述中，为了说明而不是为了限定，提出了诸如特定系统结构
、
技术之类的具体细节，以便透彻理解本申请实施例
。
然而，本领域的技术人员应当清楚，在没有这些具体细节的其它实施例中也可以实现本申请
。
在其他情况中，省略对众所周知的系统
、
装置
、
电路以及方法的详细说明，以免不必要的细节妨碍本申请的描述
。
[0042]在本申请说明书中描述的参考“一个实施例”或“一些实施例”等意味着在本申请的一个或多个实施例中包括结合该实施例描述的特定特征
、
结构或特点
。
由此，在本说明书中的不同之处出现的语句“在一个实施例中”、“在一些实施例中”、“在其他一些实施例中”、
“
在另外一些实施例中”等不是必然都参考相同的实施例，而是意味着“一个或多个但不是所有的实施例”，除非是以其他方式另外特别强调
。
术语“包括”、“包含”、“具有”及它们的变形都意味着“包括但不限于”，除非是以其他方式另外特别强本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.
基于组件化的实时功能文档系统，其特征在于，包括配置文档格式组件和配置描述组件及模板的组件；配置文档格式组件用于通过配置生成不同人群可读性高的文档，根据不同系统功能生成不同格式的文档；和
/
或配置描述组件及模板的组件和自定义注解方式组件
。2.
根据权利要求1所述的基于组件化的实时功能文档系统，其特征在于，文档模板还包括：开发人员样式的接口文档
、
非开发人员样式的各种组件文档
、
开发人员样式的系统功能文档
、
非开发人员样式的接口文档
、
非开发人员样式的各种组件文档
、
非开发人员样式的系统功能文档
、
系统概要文档
、
系统组件简要文档
、
系统组件详细文档
、
系统功能概要文档
、
和系统功能详细文档
。3.
根据权利要求1所述的基于组件化的实时功能文档系统，其特征在于，步骤一
、
设计
UML
设计图，包括接口文档
、
组件文档和生成文档工具等
。
步骤二
、
使用
Java Swing
框架实现组件化实现自动文档工具的功能
。
步骤三
、
编写
Java
程序实现配置文档格式组件和生成文档工具的功能
。4.
根据权利要求1所述的基于组件化的实时功能文档系统，其特征在于，在步骤一中，接口文档：定义接口的各个方法
、
属性和参数，以及接口的版本号和声明时间；组件文档：定义组件的接口
、
属性和方法，以及组件的版本号和声明时间；生成文档工具：定义生成文档工具的功能，以及生成不同类型文档的方法
。5.
根据权利要求1所述的基于组件化的实时功能文档系统，其特征在于...

【专利技术属性】
技术研发人员：吴江坡，
申请(专利权)人：上海通联金融服务有限公司，
类型：发明
国别省市：