CN101556577A - 一种使用xml文件将文档与程序代码组织在一起的办法 - Google Patents
一种使用xml文件将文档与程序代码组织在一起的办法 Download PDFInfo
- Publication number
- CN101556577A CN101556577A CNA2008101038602A CN200810103860A CN101556577A CN 101556577 A CN101556577 A CN 101556577A CN A2008101038602 A CNA2008101038602 A CN A2008101038602A CN 200810103860 A CN200810103860 A CN 200810103860A CN 101556577 A CN101556577 A CN 101556577A
- Authority
- CN
- China
- Prior art keywords
- document
- xml
- information
- program code
- software
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
Images
Landscapes
- Document Processing Apparatus (AREA)
Abstract
一种使用XML文件将文档与程序代码组织在一起的办法，首先制定一种XML格式的文档规范，使用规定的节点来存储软件的各种信息；在解决方案目录中，建立该格式的XML文档；为客户端提供一个各个服务接口的Web界面，客户端可以方便地阅读各个接口的文档；最后生成Word文档。本发明使得在软件开发过程中，使用规范格式的XML文件将软件的文档与程序代码组织在一起，并在后期可以自动生成Word文档。
Description
技术领域
本发明涉及一种使用XML文件将文档与程序代码组织在一起的办法，特别涉及一种采用在软件开发过程中，使用规范格式的XML文件将软件的文档与程序代码组织在一起，并在后期可以自动生成Word文档的方法。
背景技术
在软件开发过程中，保持代码与文档的同步是一个比较棘手的问题。尤其在客户端-服务器模式的软件开发中，如何让客户端方便地阅读服务器所提供的各个接口的文档，也成为提高开发效率的比较重新的因素。本发明将提供一种办法，将代码与文档组织在一起，可以实现在写代码的同时实现对文档的维护。
发明内容
本发明所要解决的技术问题是提供一种采用在软件开发过程中，使用规范格式的XML文件将软件的文档与程序代码组织在一起，并在后期可以自动生成Word文档的方法。
本发明所述的一种使用XML文件将文档与程序代码组织在一起的办法，该方法至少包括如下的步骤：
步骤1：制定一种XML格式的文档规范，使用规定的节点来存储软件的各种信息。
步骤2：在解决方案目录中，建立该格式的XML文档。
步骤3：为客户端提供一个各个服务接口的Web界面，客户端可以方便地阅读各个接口的文档。
步骤4：生成Word文档。
本发明所述的一种使用XML文件将文档与程序代码组织在一起的办法，制定一种XML格式的文档规范，使用规定的节点来存储软件的各种信息，其步骤为：
步骤11：Summary作为功能的大致描述。
步骤12：Remarks作为功能的详细描述。
步骤13：Information作为开发者等信息。
步骤14：Histories作为开发维护的历史。
步骤15：Requirement作为需求分析。
步骤16：Status Codes作为可能返回的状态码。
本发明所述的一种使用XML文件将文档与程序代码组织在一起的办法，在解决方案目录中，建立该格式的XML文档，其步骤为：
步骤21：在根目录或子文件夹中，以功能模块为单位建立这种格式的XML文档。
步骤22：尽量填写所有的信息，以保证文档的完整。
步骤23：如果日后维护，应在Histories中添加开发维护历史。
本发明所述的本发明所述的一种使用XML文件将文档与程序代码组织在一起的办法，生成Word文档，其步骤为：
步骤41：使用程序将所有的XML文档提取出来。
步骤42：分析出其中的软件信息，把各类信息汇总。
步骤43：将汇总起来的信息生成Word文档。
本发明涉及的一种使用XML文件将文档与程序代码组织在一起的办法，使得在软件开发过程中，使用规范格式的XML文件将软件的文档与程序代码组织在一起，并在后期可以自动生成Word文档。
附图说明
图1为本发明的流程图。
具体实施方式
参见图1，本发明的主要步骤如下：
步骤1：制定一种XML格式的文档规范，使用规定的节点来存储软件的各种信息。
步骤2：在解决方案目录中，建立该格式的XML文档。
步骤3：为客户端提供一个各个服务接口的Web界面，客户端可以方便地阅读各个接口的文档。
步骤4：生成Word文档。
上述步骤1制定一种XML格式的文档规范，使用规定的节点来存储软件的各种信息的具体步骤如下：
步骤11：Summary作为功能的大致描述。
步骤12：Remarks作为功能的详细描述。
步骤13：Information作为开发者等信息。
步骤14：Histories作为开发维护的历史。
步骤15：Requirement作为需求分析。
步骤16：Status Codes作为可能返回的状态码。
上述步骤2在解决方案目录中，建立该格式的XML文档的具体步骤如下：
步骤21：在根目录或子文件夹中，以功能模块为单位建立这种格式的XML文档。
步骤22：尽量填写所有的信息，以保证文档的完整。
步骤22：如果日后维护，应在Histories中添加开发维护历史。
上述步骤4生成Word文档的具体步骤如下：
步骤41：使用程序将所有的XML文档提取出来。
步骤42：分析出其中的软件信息，把各类信息汇总。
步骤43：将汇总起来的信息生成Word文档。
上述的技术方案实施时使用XML文件将文档与程序代码组织在一起的办法，使得在软件开发过程中，使用规范格式的XML文件将软件的文档与程序代码组织在一起，并在后期可以自动生成Word文档。
最后所应说明的是，以上实施例仅用以说明而并非限制本发明所描述的技术方案；因此，尽管本说明书参照上述的实施例对本发明已进行了详细的说明，但是，本领域的普通技术人员应当理解，仍然可以对本发明进行修改或者等同地替换；而一切不脱离本发明的精神和范围的技术方案及其改进，其均应涵盖在本发明的权利要求范围当中。
Claims (4)
1、一种使用XML文件将文档与程序代码组织在一起的办法，其特征在于：该方法至少包括如下的步骤：
步骤1：制定一种XML格式的文档规范，使用规定的节点来存储软件的各种信息。
步骤2：在解决方案目录中，建立该格式的XML文档。
步骤3：为客户端提供一个各个服务接口的Web界面，客户端可以方便地阅读各个接口的文档。
步骤4：生成Word文档。
2、根据权利要求1所述的一种使用XML文件将文档与程序代码组织在一起的办法，其特征在于：制定一种XML格式的文档规范，使用规定的节点来存储软件的各种信息，其步骤为：
步骤11：Summary作为功能的大致描述。
步骤12：Remarks作为功能的详细描述。
步骤13：Information作为开发者等信息。
步骤14：Histories作为开发维护的历史。
步骤15：Requirement作为需求分析。
步骤16：Status Codes作为可能返回的状态码。
3、根据权利要求1所述的一种使用XML文件将文档与程序代码组织在一起的办法，其特征在于：在解决方案目录中，建立该格式的XML文档，其步骤为：
步骤21：在根目录或子文件夹中，以功能模块为单位建立这种格式的XML文档。
步骤22：尽量填写所有的信息，以保证文档的完整。
步骤23：如果日后维护，应在Histories中添加开发维护历史。
4、根据权利要求1所述的一种使用XML文件将文档与程序代码组织在一起的办法，其特征在于：生成Word文档，其步骤为：
步骤41：使用程序将所有的XML文档提取出来。
步骤42：分析出其中的软件信息，把各类信息汇总。
步骤43：将汇总起来的信息生成Word文档。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CNA2008101038602A CN101556577A (zh) | 2008-04-11 | 2008-04-11 | 一种使用xml文件将文档与程序代码组织在一起的办法 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CNA2008101038602A CN101556577A (zh) | 2008-04-11 | 2008-04-11 | 一种使用xml文件将文档与程序代码组织在一起的办法 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN101556577A true CN101556577A (zh) | 2009-10-14 |
Family
ID=41174695
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CNA2008101038602A Pending CN101556577A (zh) | 2008-04-11 | 2008-04-11 | 一种使用xml文件将文档与程序代码组织在一起的办法 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN101556577A (zh) |
Cited By (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN102147730A (zh) * | 2011-04-19 | 2011-08-10 | Tcl通力电子（惠州）有限公司 | 一种软件规格书生成方法 |
| CN102495832A (zh) * | 2011-12-12 | 2012-06-13 | 方正国际软件有限公司 | 软件开发过程中文档自动生成系统 |
| CN102567016A (zh) * | 2011-12-07 | 2012-07-11 | 北京北大软件工程发展有限公司 | 应用程序编程接口使用示例提取方法及装置 |
| CN102103573B (zh) * | 2009-12-17 | 2012-10-03 | 北大方正集团有限公司 | 一种快速生成开放格式文档的方法及系统 |
| CN105338007A (zh) * | 2014-05-30 | 2016-02-17 | 北京金山网络科技有限公司 | 服务器集群中服务文档的获取方法、提供方法、文档服务器及中心服务器 |
-
2008
- 2008-04-11 CN CNA2008101038602A patent/CN101556577A/zh active Pending
Cited By (8)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN102103573B (zh) * | 2009-12-17 | 2012-10-03 | 北大方正集团有限公司 | 一种快速生成开放格式文档的方法及系统 |
| CN102147730A (zh) * | 2011-04-19 | 2011-08-10 | Tcl通力电子（惠州）有限公司 | 一种软件规格书生成方法 |
| CN102147730B (zh) * | 2011-04-19 | 2015-11-18 | Tcl通力电子（惠州）有限公司 | 一种软件规格书生成方法 |
| CN102567016A (zh) * | 2011-12-07 | 2012-07-11 | 北京北大软件工程发展有限公司 | 应用程序编程接口使用示例提取方法及装置 |
| CN102567016B (zh) * | 2011-12-07 | 2015-06-03 | 北京北大软件工程发展有限公司 | 应用程序编程接口使用示例提取方法及装置 |
| CN102495832A (zh) * | 2011-12-12 | 2012-06-13 | 方正国际软件有限公司 | 软件开发过程中文档自动生成系统 |
| CN105338007A (zh) * | 2014-05-30 | 2016-02-17 | 北京金山网络科技有限公司 | 服务器集群中服务文档的获取方法、提供方法、文档服务器及中心服务器 |
| CN105338007B (zh) * | 2014-05-30 | 2018-12-14 | 北京猎豹网络科技有限公司 | 服务器集群中服务文档的获取方法、提供方法、文档服务器及中心服务器 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN101408899B (zh) | 一种网站多数据源切换方法和装置 | |
| CN102810057B (zh) | 一种记录日志的方法 | |
| Wimmer et al. | Bridging grammarware and modelware | |
| CN101446971B (zh) | 构建内容管理系统的方法及装置 | |
| CN101488086A (zh) | 一种基于领域模型的软件生成方法及装置 | |
| CN1466722A (zh) | 管理文档文本的工作流程系统及利用其的文档文本管理方法 | |
| CN101477462A (zh) | 一种用于动态改变系统行为的模型驱动软件开发方法 | |
| CN103605705A (zh) | 一种变电站scd配置文件的管理系统 | |
| CN104133772A (zh) | 一种自动生成测试数据的方法 | |
| CN103019726A (zh) | 软件系统业务规则的管理方法和装置 | |
| CN101556577A (zh) | 一种使用xml文件将文档与程序代码组织在一起的办法 | |
| CN101246424A (zh) | 一种基于文件的菜单自动生成系统和方法 | |
| CN103914290A (zh) | 一种操作命令处理方法及装置 | |
| CN101697122A (zh) | 通过预定义组件生成报表查询条件的方法 | |
| CN101727505B (zh) | 一种高效的数据处理方法及装置 | |
| CN100485687C (zh) | 建立无连接的数据编程模型的方法、装置及其应用 | |
| CN110544092B (zh) | 一种区块链的动态新增多类型数据库数据操作上链方法 | |
| CN108984156A (zh) | 一种基于模板的免代码开发的软件自动生成方法及系统 | |
| US8595095B2 (en) | Framework for integrated storage of banking application data | |
| CN102486731B (zh) | 增强软件的软件调用栈的可视化的方法、设备和系统 | |
| CN104081381B (zh) | 用于实施概念服务的方法和装置 | |
| CN105681100A (zh) | 一种综合网管多协议采集调度方法 | |
| CN102314495A (zh) | 一种数据库对象的维护方法 | |
| CN102053839A (zh) | 监控探针生成方法和装置 | |
| CN101477457B (zh) | 应用模块管理系统、应用模块执行方法以及虚拟机系统 |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| C06 | Publication | ||
| PB01 | Publication | ||
| C02 | Deemed withdrawal of patent application after publication (patent law 2001) | ||
| WD01 | Invention patent application deemed withdrawn after publication |
Open date: 20091014 |