[发明专利]一种帮助文档生成装置和方法

说明书

技术领域

本发明涉及计算机技术领域，特别涉及一种帮助文档生成装置和方法。

背景技术

JavaDoc是Sun公司开发的一项技术，能够从程序源代码中抽取类、方法、成员等注释，以形成一个和源代码配套的API(Java Application Interface，应用编程接口)帮助文档。这样只要在编写程序时以预定的方式对源代码做出注释，就可以在程序编写完成后通过JavaDoc就可以获得相应格式的开发文档。

现有的JavaDoc是由开发人员在程序源代码上以注释的方式进行撰写的，而撰写的标准格式是以HTML格式。

Wiki(维基)格式是现有的一种新兴的互联网格式，使用者可以在互联网上对wiki文本进行浏览、创建、更改，而且创建、更改、发布的代价远比HTML文本为小。

在实现本发明的过程中，发明人发现现有技术至少存在以下问题：

HTML格式学习成本较高，开发人员需要学习众多的标签才能完整的书写JavaDoc，学和维护成本过高。且HTML格式是一种脚本语言，因此现有的采用HTML格式的JavaDoc直观性并不好。同时，JavaDoc不支持现有的wiki格式。

发明内容

为了解决现有技术中存在的现有的采用HTML格式的JavaDoc直观性不好且维护成本过高的问题，本发明实施例提出了一种帮助文档生成装置和方法。所述技术方案如下：

本发明实施例提出了一种帮助文档生成方法，包括：

在源代码中采用wiki格式添加注释；

将所述wiki格式的注释转换为HTML格式。

本发明实施例提出了一种帮助文档生成装置，包括：

源代码模块，用于存储源代码，以及记载于所述源代码中的注释，所述注释采用wiki格式撰写；

转换模块，用于将所述wiki格式的注释转换为HTML格式。

本发明实施例提供的技术方案带来的有益效果是：本发明实施例中，可以使用户通过简单易懂的wiki格式撰写JavaDoc，然后再将其转换成HTML格式，以降低用户的使用复杂度。同时，访问wiki的要求只是因特网连接和一个Web浏览器，比其他一些协作应用程序和组件容易部署和使用。

附图说明

图1为本发明第一实施例的流程示意图；

图2为本发明第三实施例的结构示意图。

具体实施方式

为使本发明的目的、技术方案和优点更加清楚，下面将结合附图对本发明实施方式作进一步地详细描述。

实施例1

本发明第一实施例提出了一种帮助文档生成方法，其流程如图1所示的，包括：

步骤101、在源代码中采用wiki格式添加注释；

步骤102、将所述wiki格式的注释转换为HTML格式。

本发明实施例中，可以使用户通过简单易懂的wiki格式撰写JavaDoc，然后再将其转换成HTML格式，以降低用户的使用复杂度。同时，访问wiki的要求只是因特网连接和一个Web浏览器，比其他一些协作应用程序和组件容易部署和使用。

实施例2

本发明第二实施例提出了一种帮助文档生成方法，是在前述第一实施例的基础上改进而来，所述方法具体为：

步骤201、用户针对每个欲生成API文档的类、方法、函数体等使用wiki格式撰写注释；

步骤202、通过wikiRedener将wiki格式的注释转换成对应的HTML格式。

本发明实施例中，可以通过现有的wikiRedener进行格式转换。当然，这只是实现本发明的一种方式。由于JavaDoc具有特定的HTML格式，因此可以通过其他形式的转换器进行转码，本发明实施例并不对此做出限定。

实施例3

本发明第一实施例提出了一种帮助文档生成装置，其结构如图2所示的，包括：

源代码模块1，用于存储源代码，以及记载于所述源代码中的注释，所述注释采用wiki格式撰写；

转换模块2，用于将所述wiki格式的注释转换为HTML格式。

本发明实施例中，可以使用户通过简单易懂的wiki格式撰写JavaDoc，然后再将其转换成HTML格式，以降低用户的使用复杂度。同时，访问wiki的要求只是因特网连接和一个Web浏览器，比其他一些协作应用程序和组件容易部署和使用。

实施例4

本发明第四实施例提出了一种帮助文档生成装置，是在前述第三实施例的基础上改进而来，所述系统包括：

源代码模块1，用于存储源代码，以及记载于所述源代码中的注释，所述注释采用wiki格式撰写。