CN108920181A - 文件处理方法、装置及电子设备 - Google Patents

Abstract

本公开公开了一种文件处理方法、装置及电子设备。所述方法包括：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件对应一个链接地址；将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。该方法使得对源代码进行说明性的文档能实现自动化维护和上线，无需手动维护和上线该说明性文档。

Description

文件处理方法、装置及电子设备

技术领域

本公开涉及一种文件处理方法、装置及电子设备。

背景技术

随着信息技术的飞速发展，用源代码来实现某一项功能变得原来越普及。但是阅读源代码用于理解其实现功能来说，可读性较差。

因此，通常的做法是，为了让开发人员能够快速的理解或使用一份源代码，通常需要对源代码编写相应的说明性的文档。而随着源代码开发的普及，对源代码进行说明性的文档也越来越多，技术人员需要对这些说明性文档进行管理和维护。

发明内容

有鉴于上述情况，本公开提供了一种文件处理方法、装置及电子设备，其可以高效地维护对源代码进行说明性的文档、并将其上线，提高了维护效率和便利性。

第一方面，根据本公开的实施例，提供了一种文件处理方法。该文件处理方法可包括：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

此外，根据本公开的实施例的文件处理方法，其中，基于所述第一格式文件生成网站源码文件包括：接收生成指令；根据所述生成指令基于所述第一格式文件生成网站源码文件。

此外，根据本公开的实施例的文件处理方法，其中，所述根据所述生成指令基于所述第一格式文件生成网站源码文件包括：根据生成指令将所述第一格式文件转换为第二格式文件；基于所述第二格式文件以及与网站生成有关的文件生成网站源码文件。

此外，根据本公开的实施例的文件处理方法，其中，所述第一格式文件包括markdown格式文件，所述第二格式文件包括html格式文件，所述与网站生成有关的文件包括react壳、page.json文件以及router.js文件中的一种或多种。

此外，根据本公开的实施例的文件处理方法，其中，所述将所述网站源码文件部署到服务器上包括：将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文件部署到服务器上。

此外，根据本公开的实施例的文件处理方法，其中，所述源码文件管理平台将所述网站源码文件部署到服务器上包括：所述源码文件管理平台根据预配置文件，采用webhook机制将所述网站源码文件部署到服务器上。

此外，根据本公开的实施例的文件处理方法，其中，所述方法还包括：当第一格式文件更新时，基于更新后的第一格式文件生成更新后的网站源码文件；将更新后的第一格式文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件将所述更新后的第一格式文件部署到服务器上。

此外，根据本公开的实施例的文件处理方法，其中，所述源代码与所述第一格式文件分离。

第二方面，根据本公开的实施例，提供了一种文件处理装置。该文件处理装置可包括：获得模块，用于获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；生成模块，基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；处理模块，将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

此外，根据本公开的实施例的文件处理装置，其中，所述生成子模块，具体用于根据生成指令将所述第一格式文件转换为第二格式文件；基于所述第二格式文件以及与网站生成有关的文件生成网站源码文件。

此外，根据本公开的实施例的文件处理装置，其中，所述第一格式文件包括markdown格式文件，所述第二格式文件包括html格式文件，所述与网站生成有关的文件包括react壳、page.json文件以及router.js文件。

此外，根据本公开的实施例的文件处理装置，其中，所述处理模块，具体用于将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文件部署到服务器上。

此外，根据本公开的实施例的文件处理装置，其中，所述处理模块，具体用于将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件，采用web hook机制将所述网站源码文件部署到服务器上。

此外，根据本公开的实施例的文件处理装置，其中，所述装置还包括更新模块，用于当第一格式文件更新时，基于更新后的第一格式文件生成更新后的网站源码文件；将更新后的第一格式文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件将所述更新后的第一格式文件部署到服务器上。

此外，根据本公开的实施例的文件处理装置，其中，所述源代码与所述第一格式文件分离。

第三方面，根据本公开的实施例，提供了一种电子设备。该电子设备包括存储器和处理器，该存储器与该处理器耦合，该存储器中存储指令，当该指令由该处理器执行时以使该处理器执行以下操作：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；将所述网站源码文件部署到与所述电子设备连接的服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

第四方面，根据本公开的实施例，提供了一种非瞬时性计算机可读记录介质，其上已记录用于执行上述方法的程序。

根据本公开实施例的文件处理方法、装置及电子设备，通过获得与源代码相关联的第一格式文件，基于所述第一格式文件生成网站源码文件，并将所述网站源码文件部署到服务器上，以使通过所述链接地址能够访问所述用于对所述源代码进行说明的内容，使得可以高效地维护对源代码进行说明性的文档、并将其上线，从而提高了维护效率和便利性。

要理解的是，前面的一般描述和下面的详细描述两者都是示例性的，并且意图在于提供要求保护的技术的进一步说明。

附图说明

图1是示出根据本公开实施例的一种运行环境的框图；

图2是示出根据本公开实施例的一种电子设备的结构框图；

图3是示出根据本公开第一实施例的文件处理方法的流程图；

图4是示出用于编写源代码的第三方工具的用户界面；

图5是示出根据本公开第一实施例的文件处理方法的步骤S500的流程图；

图6是示出当生成指令为od doc指令时OD工具的界面；

图7是示出根据本公开第一实施例的文件处理方法的步骤S520的流程图；

图8是示出根据本公开第一实施例的与第一格式文件相对应的网站的界面；

图9是示出根据本公开第一实施例的文件处理方法的步骤S700的流程图；

图10是示出根据本公开第二实施例的文件处理装置的功能模块示意图；

图11是示出根据本公开第二实施例的文件处理装置的生成模块820的功能模块示意图。

具体实施方式

下面将结合本公开实施例中的附图，对本公开实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本公开一部分实施例，而不是全部的实施例。基于本公开中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本公开保护的范围。

应注意到：相似的标号和字母在下面的附图中表示类似项，因此，一旦某一项在一个附图中被定义，则在随后的附图中不需要对其进行进一步定义和解释。同时，在本公开的描述中，术语“第一”、“第二”等仅用于区分描述，而不能理解为指示或暗示相对重要性。

为了管理和维护对源代码进行说明性的文档，开发人员可以采用手动维护文档的方式，即可以安排专门的人员分别源代码以及对源代码进行说明性的文档进行手动的开发、维护、更新、上线和运维等，但这样会消耗很多的人力和时间来编写说明性文档,并且文档的升级更新也不及时，另外，还可能存在编写说明性文档和编写源代码的人可能不是同一个人的情况,而导致在编写说明性文档时存在理解上的偏差。

另外，开发人员也可以采用在源代码中直接编写注释的方式来管理和维护对源代码进行说明性的文档，例如，Java doc，这种方式下，通过解析doc注释，从而生成说明性文档，但是，在源代码中编写注释的方式不适合加入大段的示例代码/可运行demo，并且，也不能生成富交互的文档,例如，图片和响应式的文档。

为此，本发明实施例提供了文件处理方法、装置及电子设备，用于解决上述问题。

图1示出了本发明实施例提供的一种运行环境的示意图。该运行环境中包括了电子设备100、源码文件管理平台200、以及服务器300。其中，电子设备100可以包括，但不限于例如，下述设备中的至少一个：个人计算机(PC)、膝上型计算机、上网本计算机、台式PC等。该源码文件管理平台200可以包括，但不限于例如，软件程序或安装有软件程序的硬件设备，其中，安装有软件程序的硬件设备可以包括，但不限于例如，下述设备中的至少一个：个人计算机(PC)、膝上型计算机、上网本计算机、台式PC、网络服务器、数据库服务器等。另外，当该源码文件管理平台200作为软件程序时，其可以位于电子设备100中或者位于服务器300中。服务器300可以包括，但不限于例如，下述设备中的至少一个：个人计算机(PC)、膝上型计算机、上网本计算机、台式PC、网络服务器、数据库服务器等。

作为一种实施方式，电子设备100、源码文件管理平台200以及服务器300相互之间可以通信以实现数据通信。可以使用电子设备100对文件进行处理以生成网站源码文件，并将网站源码文件上传到源码文件管理平台200，从而触发该源码文件管理平台200将所述网站源码文件部署到服务器300上，以高效地维护对源代码进行说明性的文档、并将其上线，从而提高了维护效率和便利性。具体的实施过程将在后续进行详细描述。

本发明实施例提供的文件处理方法可以运行于图1所示的电子设备100中。如图2所示，是电子设备100的方框示意图。电子设备100可以包括存储器110、一个或多个(图中仅示出一个)处理器120、外设接口130、输入输出单元140、显示单元150等。这些组件通过一条或多条通讯总线/信号线相互通讯。

存储器110可用于存储软件程序以及模块，如本发明实施例中的文件处理方法以及装置对应的程序指令/模块，处理器120通过运行存储在存储器110内的软件程序以及模块，从而执行各种功能应用以及数据处理，如本发明实施例提供的文件处理方法。

存储器110可包括高速随机存储器，还可包括非易失性存储器，如一个或者多个磁性存储装置、闪存、或者其他非易失性固态存储器。

外设接口130将各种输入/输入装置耦合至处理器120以及存储器102。在一些实施例中，外设接口130以及处理器120可以在单个芯片中实现。在其他一些实例中，他们可以分别由独立的芯片实现。

输入输出单元140可以接收用户的输入，例如，符号、文字、图形等的输入，也可以是向用户输出，例如，符号、文字、图形、音频等输出，该输入输出单元140可以包括键盘、鼠标、音频/视频输入输出设备等。

显示单元150在电子设备100与用户之间提供输出及输入界面。具体地，显示单元150向用户显示文字、图形、视频及其任意组合。

可以理解，图2所示的结构仅为示意，电子设备100还可包括比图2中所示更多或者更少的组件，或者具有与图2所示不同的配置。图2中所示的各组件可以采用硬件、软件或其组合实现。

本发明实施例中，电子设备100可以预先安装用于编写源代码的第三方工具以及用于接收生成指令的第三方工具。下面将结合附图对本公开实施例中的文件处理方法及装置进行更详细的描述。

图3示出了根据本公开第一实施例的文件处理方法的流程图，请参阅图3，本实施例描述的是电子设备的处理流程，该方法包括：步骤S400，获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；步骤S500，基于所述第一格式文件生成网站源码文件，所述网站源码文件对应一个链接地址；步骤S600，将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

在图3中的步骤S400，获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容。

所述源代码为采用特定编程语言编写的用于实现特定功能的文件，具体地，特定编程语言可以包括JavaScript、Java、c、c++等。特定功能可以根据用户的需求进行设置，例如，实现界面可视化的功能。

与源代码相关联的第一格式文件是用于对源代码进行说明的文件，例如，若源代码要实现界面可视化的功能，该第一格式文件中可以包括对界面内容的说明，例如，界面上各类元素的默认类型、默认尺寸等。

作为一种实施方式，该第一格式文件为markdown(向下标记)格式文件。markdown是一种可以使用普通文本编辑器编写的标记语言，通过简单的标记语法，它可以使普通文本内容具有一定的格式。当然第一格式文件还可以为其他格式文件，只要能实现本发明的目的。

作为一种实施方式，若源代码与多个第一格式文件相关联时，可以递归解析与该源代码相关联所有第一格式文件，从而获得与源代码相关联的多个第一格式文件。

作为一种实施方式，所述源代码与所述第一格式文件分离。

请参考图4，图4示出了用于编写源代码的第三方工具的用户界面。该用户界面中包括源代码和第一格式文件的用户界面。

如图4中界面的左侧所示，index.js文件为项目src对应的一个源代码，其可以是用于实现按钮功能的源代码，而button.md为与index.js文件相对应的对该源代码index.js进行说明的第一格式文件，其可以是用于对按钮的默认类型、默认尺寸等的说明，该第一格式文件为markdown格式文件。在该实施例中，源代码index.js与第一格式文件button.md相互分离，互不影响。如图4中界面的右侧所示，其为第一格式文件button.md文件中包括的内容，可见，该第一格式文件中包括的内容的格式非常简单，书写方便并且支持度广。

通过这种方式，使得开发人员无需采用在源代码中直接编写注释的方式来管理和维护对源代码进行说明性的文档，而是可以将源代码和该说明性的文档进行分开管理，解决了注释里不适合大段代码、大段说明和多种调用demo(演示样本)的问题，将这些复杂篇幅大的文档转移到markdown中；并且由于markdown格式文件非常简单且书写方便，解决了在源代码中直接编写注释的篇幅受限的问题并且适用范围更广,同时markdown中支持超文本，并且支持富交互文档，从而使得第一格式文件对应的网站能够有更好的体验。进一步的，该第一格式文件和该源代码是开发人员在开发时同时编写的，解决了编写说明性文档和编写源代码的人可能不是同一个人的情况而导致的在编写说明性文档时存在理解上的偏差的问题。

请继续参阅图3，图3所示的文件处理方法还可以包括步骤S500，基于所述第一格式文件生成网站源码文件，所述网站源码文件对应一个链接地址。

作为步骤S500的一种实施方式，该网站源码文件对应的链接地址可以预先作为配置文件中的一项存储在源码文件管理平台，作为一种实施方式，该源码文件管理平台可以为GitLab平台。GitLab平台是一个用于仓库管理系统的开源项目平台，使用Git作为代码管理工具，并在此基础上搭建起来的web服务。

例如，可以在源码文件管理平台中预先存储一个配置文件，该配置文件中将该网站源码文件的项目信息(例如，项目名称)与该链接地址进行映射，根据该网站源码文件的项目信息可以获得对应的链接地址。作为一种实施方式，该配置文件可以是package.json文件。

作为一种实施方式，请参阅图5，图5是根据本公开第一实施例的文件处理方法的步骤S500的流程图。该步骤S500的流程图包括：步骤S510，接收生成指令；和步骤S520，根据所述生成指令基于所述第一格式文件生成网站源码文件。

在步骤S510，接收生成指令。作为一种实施方式，可以利用预先安装的用于接收生成指令的第三方工具来接收该生成指令。具体地，该第三方工具可以是OD工具，该生成指令可以是od doc指令。其中，OD(Ollydbg)工具是反汇编工作的常用工具，其具体功能不做赘述。例如，在电子设备的用户操作该第三方工具而生成该生成指令。

步骤S520，根据所述生成指令基于所述第一格式文件生成网站源码文件。

作为一种实施方式，当第三方工具接收到生成指令时，第三方工具根据该生成指令，生成与所述第一格式文件对应的网站源码文件。

例如，请参阅图6，图6示出了当生成指令为od doc指令时OD工具的界面。当OD工具接收到用户输入的od doc指令时，可以一键生成与第一格式文件对应的网站源码文件。

作为一种实施方式，请参阅图7，图7是根据本公开第一实施例的文件处理方法的步骤S520的流程图。

步骤S521，根据生成指令，将所述第一格式文件转换为第二格式文件。

作为一种实施方式，所述第一格式文件可以包括markdown格式文件，所述第二格式文件可以包括html(超文本标记语言)格式文件。

例如，当OD工具接收到用户输入的od doc指令时，自动将该markdown格式文件转换为html格式文件。

步骤S522，基于所述第二格式文件以及与网站生成有关的文件，生成网站源码文件。

作为一种实施方式，所述与网站生成有关的文件可以包括react(反应)壳、page.json(页面)文件以及router.js(路由)文件。其中，该react壳是用于实现网站的框架文件，该page.json文件可以是用于对网站页面布局等进行描述的文件，该router.js文件可以是用于对路由进行描述的文件。

具体地，基于该html格式文件，并通过解析react壳、page.json文件以及router.js文件可以生成网站源码文件。

通过这种方式，进一步解决了开发人员手动维护文档的方式带来的不变，使得能够通过简单的命令操作，自动解析并转换第一格式文件，并自动化实现一键生成网站源码文件。

请继续参阅图3，在图3所示的文件处理方法的步骤S600中，将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

作为一种实施方式，步骤S600可以包括：将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文件部署到服务器上。

该源码文件管理平台可以为GitLab平台。GitLab平台是一个用于仓库管理系统的开源项目平台，使用Git作为代码管理工具，并在此基础上搭建起来的web服务。

进一步的，步骤S600可以包括：所述源码文件管理平台根据预配置文件，采用webhook(网络钩子)机制将所述网站源码文件部署到服务器上。

具体地，可以预先在GitLab平台存储预配置文件，该配置文件对web hook机制中的git钩子服务进行配置，使得当GitLab平台检测到网站源码文件上传时，能够立即触发源码文件管理平台自动向服务器发起请求，以请求服务器将所述网站源码文件进行部署。进一步的，也可以向用于实现负载均衡的服务器发起请求，例如nginx(engine x，引擎x)服务器，以使该用于实现负载均衡的服务器服务器采用多个代理(例如，nginx代理)对该网站源码文件进行部署，从而进一步减轻服务器300的部署负载。

通过这种方式，使得能够直接调用服务器的远端服务,可以自动化实现文档上线的服务，无需开发者关心第一格式文件对应的网站的上线、部署、运维等。

请参阅图8，图8是示出根据本公开第一实施例的与第一格式文件相对应的网站的界面。

当将所述网站源码文件部署到服务器上，可以通过链接地址对与第一格式文件相对应的网站进行访问，该网站页面中包括了用于对所述源代码进行说明的内容。如图8所示，该网站页面中的内容与图4中的button.md文件中包括的内容相对应，用户可以通过访问该网站页面访问用于对所述源代码进行说明的内容，即该button.md文件中的内容，并且通过访问网站页面的方式进行内容的查看，对用户来说是更加友好的。

作为一种实施方式，图3所示的文件处理方法还包括步骤S700，请参阅图9，图9是示出根据本公开第一实施例的文件处理方法的步骤S700的流程图，包括：步骤S710和和步骤S720。所述步骤S710和S720用于说明在更新第一格式文件时的处理操作。

步骤S710，当第一格式文件更新时，基于更新后的第一格式文件生成更新后的网站源码文件。

其中，基于更新后的第一格式文件生成更新后的网站源码文件的具体实施过程可以参考步骤S500的描述，此处不再赘述。

步骤S720，将更新后的第一格式文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件将所述更新后的第一格式文件部署到服务器上。

其中，步骤S720的具体实施过程可以参考步骤S600的描述，此处不再赘述。

通过这种方式，实现了文档的自动化更新，并且由于操作简便，使得文档的升级更新也更加及时。

通过本公开实施例提供的文件处理方法，使得可以高效地维护对源代码进行说明性的文档、并将其上线，从而提高了维护效率和便利性。

此外，通过本公开实施例提供的文件处理方法，使得开发人员可以将源代码和对源代码进行说明性的文档进行分开管理，并且由于markdown格式文件非常简单且书写方便，解决了在源代码中直接编写注释的篇幅受限的问题，并且适用范围更广,同时markdown中支持超文本，并且支持富交互文档，从而使得第一格式文件对应的网站能够有更好的体验。进一步的，该第一格式文件和该源代码是开发人员在开发时同时编写的，解决了编写说明性文档和编写源代码的人可能不是同一个人的情况导致的在编写说明性文档时存在理解上的偏差的问题。

此外，通过本公开实施例提供的文件处理方法，进一步解决了开发人员手动维护文档的方式带来的不变，使得能够通过简单的命令操作，自动解析并转换第一格式文件，并自动化实现一键生成网站源码文件。

此外，通过本公开实施例提供的文件处理方法，使得能够直接调用服务器的远端服务,可以自动化实现文档上线的服务，无需开发者关心第一格式文件对应的网站的上线、部署、运维等。

此外，通过本公开实施例提供的文件处理方法，使得用于对所述源代码进行说明的内容可以更加方便和友好的被用户访问。

此外，通过本公开实施例提供的文件处理方法，实现了文档的自动化更新，并且由于操作简便，使得文档的升级更新也更加及时。

图10是示出根据本公开第二实施例的文件处理装置800的功能模块示意图。该文件处理装置800运行于电子终端中。该文件处理装置800包括获得模块810、生成模块820以及处理模块830。

获得模块810，用于获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容。

所述源代码与所述第一格式文件分离。

生成模块820，基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应。

作为一种实施方式，请参阅图11，图11是示出根据本公开第二实施例的文件处理装置的生成模块820的功能模块示意图，所述生成模块820包括接收模块821和生成子模块822。

所述接收模块821，用于接收生成指令。

所述生成子模块822，用于根据所述生成指令基于所述第一格式文件生成网站源码文件。

具体地，所述生成子模块822可以根据生成指令，将所述第一格式文件转换为第二格式文件；基于所述第二格式文件以及与网站生成有关的文件，生成网站源码文件。

所述第一格式文件例如可包括markdown格式文件。所述第二格式文件例如可包括html格式文件。所述与网站生成有关的文件例如可包括react壳、page.json文件以及router.js文件。这里仅仅给出了第一格式文件、第二格式文件、和与网站生成有关的文件的示例。在具体实现中，可以根据需要采取其它格式，具体的格式不构成对本公开实施例的限制。

处理模块830将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

作为一种实施方式，所述处理模块830，具体用于将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文件部署到服务器上。

具体地，所述处理模块830具体用于将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件，采用web hook机制将所述网站源码文件部署到服务器上。

作为一种实施方式，请参阅图10，所述装置还包括更新模块840，用于当第一格式文件更新时，基于更新后的第一格式文件生成更新后的网站源码文件；将更新后的第一格式文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件将所述更新后的第一格式文件部署到服务器上。

通过本公开实施例提供的文件处理装置，使得可以高效地维护对源代码进行说明性的文档、并将其上线，从而提高了维护效率和便利性。此外，使得开发人员可以将源代码和对源代码进行说明性的文档进行分开管理，并且由于markdown格式文件非常简单且书写方便，解决了在源代码中直接编写注释的篇幅受限的问题并且适用范围更广,同时markdown中支持超文本，并且支持富交互文档，从而使得第一格式文件对应的网站能够有更好的体验。进一步的，该第一格式文件和该源代码是开发人员在开发时同时编写的，解决了编写说明性文档和编写源代码的人可能不是同一个人的情况导致的在编写说明性文档时存在理解上的偏差的问题。此外，进一步解决了开发人员手动维护文档的方式带来的不变，使得能够通过简单的命令操作，自动解析并转换第一格式文件，并自动化实现一键生成网站源码文件。此外，使得能够直接调用服务器的远端服务,可以自动化实现文档上线的服务，无需开发者关心第一格式文件对应的网站的上线、部署、运维等。此外，实现了文档的自动化更新，并且由于操作简便，使得文档的升级更新也更加及时。此外，使得用于对所述源代码进行说明的内容可以更加方便和友好的被用户访问。

以上各模块可以是由软件代码实现，也同样可以由硬件例如集成电路芯片实现。

本公开的第三实施例提供了一种电子设备，该电子设备包括存储器和处理器，该存储器与该处理器耦合，该存储器中存储指令，当该指令由该处理器执行时以使该处理器执行以下操作：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；将所述网站源码文件部署到与所述电子设备连接的服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

通过本公开实施例提供的电子设备，使得可以高效地维护对源代码进行说明性的文档、并将其上线，从而提高了维护效率和便利性。此外，使得开发人员可以将源代码和对源代码进行说明性的文档进行分开管理，并且由于markdown格式文件非常简单且书写方便，解决了在源代码中直接编写注释的篇幅受限的问题并且适用范围更广,同时markdown中支持超文本，并且支持富交互文档，从而使得第一格式文件对应的网站能够有更好的体验。进一步的，该第一格式文件和该源代码是开发人员在开发时同时编写的，解决了编写说明性文档和编写源代码的人可能不是同一个人的情况导致的在编写说明性文档时存在理解上的偏差的问题。此外，进一步解决了开发人员手动维护文档的方式带来的不变，使得能够通过简单的命令操作，自动解析并转换第一格式文件，并自动化实现一键生成网站源码文件。此外，使得能够直接调用服务器的远端服务,可以自动化实现文档上线的服务，无需开发者关心第一格式文件对应的网站的上线、部署、运维等。此外，实现了文档的自动化更新，并且由于操作简便，使得文档的升级更新也更加及时。此外，使得用于对所述源代码进行说明的内容可以更加方便和友好的被用户访问。

需要说明的是，本说明书中的各个实施例均采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似的部分互相参见即可。

本公开实施例所提供的文件处理装置及电子设备，其实现原理及产生的技术效果和前述方法实施例相同，为简要描述，装置实施例部分未提及之处，可参考前述方法实施例中相应内容。

在本申请所提供的几个实施例中，应该理解到，所揭露的装置和方法，也可以通过其它的方式实现。以上所描述的装置实施例仅仅是示意性的，例如，附图中的流程图和框图显示了根据本公开的多个实施例的装置、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段或代码的一部分，该模块、程序段或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在有些作为替换的实现方式中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个连续的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，框图和/或流程图中的每个方框、以及框图和/或流程图中的方框的组合，可以用执行规定的功能或动作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

另外，在本公开各个实施例中的各功能模块可以集成在一起形成一个独立的部分，也可以是各个模块单独存在，也可以两个或两个以上模块集成形成一个独立的部分。

所述功能如果以软件功能模块的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本公开的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本公开各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(ROM，Read-Only Memory)、随机存取存储器(RAM，Random Access Memory)、磁碟或者光盘等各种可以存储程序代码的介质。需要说明的是，在本文中，诸如第一和第三等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

以上所述仅为本公开的优选实施例而已，并不用于限制本公开，对于本领域的技术人员来说，本公开可以有各种更改和变化。凡在本公开的精神和原则之内，所作的任何修改、等同替换、改进等，均应包含在本公开的保护范围之内。应注意到：相似的标号和字母在下面的附图中表示类似项，因此，一旦某一项在一个附图中被定义，则在随后的附图中不需要对其进行进一步定义和解释。

以上所述，仅为本公开的具体实施方式，但本公开的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本公开揭露的技术范围内，可轻易想到变化或替换，都应涵盖在本公开的保护范围之内。因此，本公开的保护范围应以所附权利要求及其等同物的保护范围为准。

Claims (10)

1.一种文件处理方法，包括：

获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；

基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；

将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

2.根据权利要求1所述的方法，其中，基于所述第一格式文件生成网站源码文件包括：

接收生成指令；

根据所述生成指令基于所述第一格式文件生成网站源码文件。

3.根据权利要求1所述的方法，其中，所述根据所述生成指令基于所述第一格式文件生成网站源码文件包括：

根据生成指令将所述第一格式文件转换为第二格式文件；

基于所述第二格式文件以及与网站生成有关的文件生成网站源码文件。

4.根据权利要求3所述的方法，其中，所述第一格式文件包括markdown格式文件，所述第二格式文件包括html格式文件，所述与网站生成有关的文件包括react壳、page.json文件以及router.js文件中的一种或多种。

5.根据权利要求1所述的方法，其中，所述将所述网站源码文件部署到服务器上包括：

将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文件部署到服务器上。

6.根据权利要求5所述的方法，其中，所述源码文件管理平台将所述网站源码文件部署到服务器上包括：

所述源码文件管理平台根据预配置文件，采用web hook机制将所述网站源码文件部署到服务器上。

7.根据权利要求1所述的方法，其中，所述方法还包括：

当第一格式文件更新时，基于更新后的第一格式文件生成更新后的网站源码文件；

将更新后的第一格式文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件将所述更新后的第一格式文件部署到服务器上。

8.根据权利要求1所述的方法，其中，所述源代码与所述第一格式文件分离。

9.一种文件处理装置，包括：

获得模块，用于获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；

生成模块，基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；

处理模块，将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

10.根据权利要求9所述的装置，其中，所述生成模块包括接收模块和生成子模块，

所述接收模块，用于接收生成指令；

所述生成子模块，用于根据所述生成指令基于所述第一格式文件生成网站源码文件。