>[0065]在生成说明文档之前需要预先创建使用说明和示例代码，本实施例在markdown下创建使用说明。在本实施例中，使用说明保存在第一文件中，例如，第一文件可以包括文件名称为readme, md的一个文件；示例代码保存在第二文件中，例如，第二文件可以包括文件名称分别为demo, html和demo, js的两个文件，这两个文件中的示例代码都是可以运行的；源码保存在第三文件中，例如，第三文件可以包括文件名称为componentA.js的一个文件。
[0066]请参考图4，为本实施例提供的一种方法的流程图，可以包括以下步骤:
[0067]步骤401:在markdown下创建组件A的使用说明并将其保存在第一文件中；
[0068]步骤402:创建组件A的示例代码并将其保存在第二文件中；
[0069]需要说明的是，后续步骤通过调用grunt来实现。需要指出的是，grunt的配置信息包括预先定义的组件名称、预先定义的第一文件的文件名称以及预先定义的第二文件的文件名称，grunt的配置信息还包括使用说明和示例代码，与预先定义的组件名称、第一文件的文件名称以及第二文件的文件名称不同的是，grunt的配置信息中的使用说明和示例代码需要在grunt查找到所需的使用说明和示例代码后来写入，如下文所描述的。
[0070]步骤403:根据grunt的配置信息中预先定义的组件A的名称查找组件A ；
[0071]步骤404:根据grunt的配置信息中预先定义的第一文件的文件名称查找组件A的使用说明；
[0072]步骤405:根据grunt的配置信息中预先定义的第二文件的文件名称查找组件A的示例代码；
[0073]步骤406:将使用说明和示例代码写入grunt的配置信息中；
[0074]步骤407:获取说明文档的html页面模板；
[0075]步骤408:将配置信息中的使用说明和示例代码解析到html页面模板中，从而生成html文档形式的说明文档；
[0076]步骤409:将说明文档输出到grunt的配置目标文件中。
[0077]步骤410:以html页面的形式向组件的使用者展示组件A的说明文档。
[0078]可以看出，该实施例在生成说明文档时不再从源码的注释中获取使用说明和示例代码，所以程序开发人员不必花费大量的时间和精力来编写注释，而且由于示例代码独立于注释是可以运行的，所以示例代码还可以用来对组件进行测试，故程序开发人员无需准备两份代码来分别用于生成说明文档和对组件进行测试。此外，在该实施例中，使用说明是在markdown下创建的，因为markdown有专门的可视化编辑工具，所以可以可视化创建使用说明，从而便于根据所期望的使用说明的格式随时进行调整。
[0079]如本领域技术人员可以理解的，本发明的方法所提供的步骤可以以不同的顺序来执行。例如，在图4中，步骤401和步骤402的执行顺序可以互换。再如，在图4中，步骤404和步骤405的执行顺序也可以互换。
[0080]如本领域技术人员可以理解的，对于步骤408，可替换地，将配置信息中的示例代码解析到html页面模板中并将配置信息中的使用说明保存在html页面模板中。此时，对于步骤410，可替换地，对html页面模板中的使用说明进行渲染，并以html页面的形式向组件的使用者展示组件A的说明文档。
[0081]请参考图5，为本发明提供的一种装置的框图，可以包括以下单元:
[0082]第一查找单元501，用于遍历至少一个组件，查找使用者所需的组件；
[0083]第一获取单元502，用于从预先创建的第一文件中获取使用说明，第一文件独立于保存源码的文件；
[0084]第二获取单元503，用于从预先创建的第二文件中获取示例代码，第二文件独立于保存源码的文件，并且第二文件中的示例代码能够运行；
[0085]生成单元504，用于由获取的使用说明和示例代码生成组件的说明文档。
[0086]可以看出，由于组件的使用说明和示例代码均以独立于源码的形式保存在各自的文件中，不再包含在源码的注释中，所以程序开发人员在编写源码的过程中无需对注释花费过多精力和时间，并且由于本发明的示例代码可以运行，所以通过本发明，示例代码还可以用于测试组件，故程序开发人员无需准备两份代码分别用于生成说明文档和测试组件，从而极大地减轻了程序开发人员的负担。
[0087]请参考图6，为本发明一个实施例提供的装置的框图，该实施例中所包含的单元如下:
[0088]第一获取单元502包括:
[0089]第二查找单元601，用于根据grunt的配置信息中预先定义的第一文件的文件名称查找使用说明；
[0090]第二获取单元503包括:
[0091]第三查找单元602，用于根据grunt的配置信息中预先定义的第二文件的文件名称查找示例代码。
[0092]生成单元504包括:
[0093]写入单元603，用于将获取的使用说明和示例代码写入grunt的配置信息中；
[0094]第三获取单元604，用于获取说明文档的html页面模板；
[0095]结合单元605，用于将配置信息中的使用说明和示例代码与html页面模板进行结合，从而生成html文档形式的说明文档。
[0096]结合单元605包括:
[0097]第一解析单元606，用于将配置信息中的使用说明和示例代码解析到html页面模板中。
[0098]可替换地，结合单元605包括:
[0099]第二解析单元，用于将配置信息中的示例代码解析到html页面模板中；
[0100]保存单元，用于将配置信息中的使用说明保存在html页面模板中。
[0101]此处使用的术语仅是为了描述具体的实施例，意不在限制。如此处使用的，除非上下文清楚指出，术语“包括”是包含的，因此详细说明陈述的特征、整体、步骤、操作、元件、和/或部件，并不排除一个或者多个其它的特征、整体、步骤、操作、元件、部件、和/或其组合的存在或附加。
[0102]提供本实施例的描述目的是进行说明，意不在穷尽或者限制本发明。单个部件或者特征不限制在该实施例中，即使没有具体示出或者进行描述，也可以在可应用的选择的实施例中进行互换并使用。还可以按照许多方式进行变化，这些变化并未脱离本发明，并且所有这些改变意在包含在本发明的范围内。
【主权项】
1.一种生成说明文档的方法，其特征在于，所述方法包括: 遍历至少一个组件，查找使用者所需的组件； 从预先创建的第一文件中获取使用者所需的组件的使用说明，所述第一文件独立于保存源码的文件； 从预先创建的第二文件中获取使用者所需的组件的示例代码，所述第二文件独立于保存源码的文件，并且所述第二文件中的示例代码能够运行； 由获取的所述使用说明和所述示例代码生成使用者所需的组件的说明文档。2.根据权利要求1所述的方法，其特征在于， 从预先创建的第一文件中获取使用说明包括: 根据grunt的配置信息中预先定义的所述第一文件的文件名称查找所述使用说明； 从预先创建的第二文件中获取示例代码包括: 根据grunt的配置信息中预先定义的所述第二文件的文件名称查找所述示例代码。3.根据权利要求2所述的方法，其特征在于，由获取的使用说明和示例代码生成组件的说明文档包括: 将获取的所述使用说明和所述示例代码写入grunt的配置信息中； 获取所述说明文档的html页面模板； 将配置信息中的所述使用说明和所述示例代码与所述html页面模板进行结合，从而生成html文档形式的说明文档。4.根据权利要求3所述的方法，其特征在于，将配置信息中的所述使用说明和所述示例代码与所述html页面模板进行结合包括: 将配置信息中的所述使用说明和所述示例代码解析到所述html页面模板中。5.根据权利要求3所述的方法，其特征在于，将配置信息中的所述使用说明和所述示例代码与所述html页面模板进行结合包括: 将配置信息中的所述示例代码解析到所述html页面模板中，并将配置信息中的使用说明保存在所述html页面模板中。6.一种生成说明文档的装置，其特征在于，所述装置包括: 第一查找单元，用于遍历至少一个组件，查找使用者所需的组件； 第一获取单元，用于从预先创建的第一文件中获取使用说明，所述第一文件独立于保存源码的文件； 第二获取单元，用于从预先创建的第二文件中获取示例代码，所述第二文件独立于保存源码的文件，并且所述第二文件中的示例代码能够运行； 生成单元，用于由获取的所述使用说明和所述示例代码生成组件的说明文档。7.根据权利要求6所述的装置，其特征在于， 所述第一获取单元包括: 第二查找单元，用于根据grunt的配置信息中预先定义的所述第一文件的文件名称查找所述使用说明； 所述第二获取单元包括: 第三查找单元，用于根据grunt的配置信息中预先定义的所述第二文件的文件名称查找所述示例代码。8.根据权利要求7所述的装置，其特征在于，所述生成单元包括: 写入单元，用于将获取的所述使用说明和所述示例代码写入grunt的配置信息中； 第三获取单元，用于获取所述说明文档的html页面模板； 结合单元，用于将配置信息中的所述使用说明和所述示例代码与所述html页面模板进行结合，从而生成html文档形式的说明文档。9.根据权利要求8所述的装置，其特征在于，所述结合单元包括: 第一解析单元，用于将配置信息中的所述使用说明和所述示例代码解析到所述html页面模板中。10.根据权利要求8所述的装置，其特征在于，所述结合单元包括: 第二解析单元，用于将配置信息中的所述示例代码解析到所述html页面模板中； 保存单元，用于将配置信息中的使用说明保存在所述html页面模板中。
【专利摘要】本发明公开了一种生成说明文档的方法和装置。该方法包括：遍历至少一个组件，查找使用者所需的组件；从预先创建的第一文件中获取使用者所需的组件的使用说明，第一文件独立于保存源码的文件；从预先创建的第二文件中获取使用者所需的组件的示例代码，第二文件独立于保存源码的文件，并且第二文件中的示例代码能够运行；由获取的使用说明和示例代码生成使用者所需的组件的说明文档。通过本发明，减轻了程序开发人员的负担。
【IPC分类】G06F17/30, G06F9/44
【公开号】CN105094836
【申请号】CN201510490664
【发明人】刘江涛, 张鹏
【申请人】北京京东尚科信息技术有限公司, 北京京东世纪贸易有限公司
【公开日】2015年11月25日
【申请日】2015年8月11日