文件处理方法、装置及电子设备制造方法及图纸

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

File Processing Method, Device and Electronic Equipment

The present disclosure discloses a document processing method, a device and an electronic device. The method includes: obtaining the first format file associated with the source code, the first format file includes the content for explaining the source code, generating the website source file based on the first format file, the website source file corresponds to a link address, and deploying the website source file to the On the server, the content for explaining the source code can be accessed through the link address. This method makes it possible to maintain and upload the descriptive document of source code automatically without manual maintenance and uploading the descriptive document.

【技术实现步骤摘要】
文件处理方法、装置及电子设备
本公开涉及一种文件处理方法、装置及电子设备。
技术介绍
随着信息技术的飞速发展，用源代码来实现某一项功能变得原来越普及。但是阅读源代码用于理解其实现功能来说，可读性较差。因此，通常的做法是，为了让开发人员能够快速的理解或使用一份源代码，通常需要对源代码编写相应的说明性的文档。而随着源代码开发的普及，对源代码进行说明性的文档也越来越多，技术人员需要对这些说明性文档进行管理和维护。
技术实现思路
有鉴于上述情况，本公开提供了一种文件处理方法、装置及电子设备，其可以高效地维护对源代码进行说明性的文档、并将其上线，提高了维护效率和便利性。第一方面，根据本公开的实施例，提供了一种文件处理方法。该文件处理方法可包括：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。此外，根据本公开的实施例的文件处理方法，其中，基于所述第一格式文件生成网站源码文件包括：接收生成指令；根据所述生成指令基于所述第一格式文件生成网站源码文件。此外，根据本公开的实施例的文件处理方法，其中，所述根据所述生成指令基于所述第一格式文件生成网站源码文件包括：根据生成指令将所述第一格式文件转换为第二格式文件；基于所述第二格式文件以及与网站生成有关的文件生成网站源码文件。此外，根据本公开的实施例的文件处理方法，其中，所述第一格式文件包括markdown格式文件，所述第二格式文件包括html格式文件，所述与网站生成有关的文件包括react壳、page.json文件以及router.js文件中的一种或多种。此外，根据本公开的实施例的文件处理方法，其中，所述将所述网站源码文件部署到服务器上包括：将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文件部署到服务器上。此外，根据本公开的实施例的文件处理方法，其中，所述源码文件管理平台将所述网站源码文件部署到服务器上包括：所述源码文件管理平台根据预配置文件，采用webhook机制将所述网站源码文件部署到服务器上。此外，根据本公开的实施例的文件处理方法，其中，所述方法还包括：当第一格式文件更新时，基于更新后的第一格式文件生成更新后的网站源码文件；将更新后的第一格式文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件将所述更新后的第一格式文件部署到服务器上。此外，根据本公开的实施例的文件处理方法，其中，所述源代码与所述第一格式文件分离。第二方面，根据本公开的实施例，提供了一种文件处理装置。该文件处理装置可包括：获得模块，用于获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；生成模块，基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；处理模块，将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。此外，根据本公开的实施例的文件处理装置，其中，所述生成子模块，具体用于根据生成指令将所述第一格式文件转换为第二格式文件；基于所述第二格式文件以及与网站生成有关的文件生成网站源码文件。此外，根据本公开的实施例的文件处理装置，其中，所述第一格式文件包括markdown格式文件，所述第二格式文件包括html格式文件，所述与网站生成有关的文件包括react壳、page.json文件以及router.js文件。此外，根据本公开的实施例的文件处理装置，其中，所述处理模块，具体用于将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文件部署到服务器上。此外，根据本公开的实施例的文件处理装置，其中，所述处理模块，具体用于将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件，采用webhook机制将所述网站源码文件部署到服务器上。此外，根据本公开的实施例的文件处理装置，其中，所述装置还包括更新模块，用于当第一格式文件更新时，基于更新后的第一格式文件生成更新后的网站源码文件；将更新后的第一格式文件上传到源码文件管理平台，以触发所述源码文件管理平台根据预配置文件将所述更新后的第一格式文件部署到服务器上。此外，根据本公开的实施例的文件处理装置，其中，所述源代码与所述第一格式文件分离。第三方面，根据本公开的实施例，提供了一种电子设备。该电子设备包括存储器和处理器，该存储器与该处理器耦合，该存储器中存储指令，当该指令由该处理器执行时以使该处理器执行以下操作：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；将所述网站源码文件部署到与所述电子设备连接的服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。第四方面，根据本公开的实施例，提供了一种非瞬时性计算机可读记录介质，其上已记录用于执行上述方法的程序。根据本公开实施例的文件处理方法、装置及电子设备，通过获得与源代码相关联的第一格式文件，基于所述第一格式文件生成网站源码文件，并将所述网站源码文件部署到服务器上，以使通过所述链接地址能够访问所述用于对所述源代码进行说明的内容，使得可以高效地维护对源代码进行说明性的文档、并将其上线，从而提高了维护效率和便利性。要理解的是，前面的一般描述和下面的详细描述两者都是示例性的，并且意图在于提供要求保护的技术的进一步说明。附图说明图1是示出根据本公开实施例的一种运行环境的框图；图2是示出根据本公开实施例的一种电子设备的结构框图；图3是示出根据本公开第一实施例的文件处理方法的流程图；图4是示出用于编写源代码的第三方工具的用户界面；图5是示出根据本公开第一实施例的文件处理方法的步骤S500的流程图；图6是示出当生成指令为oddoc指令时OD工具的界面；图7是示出根据本公开第一实施例的文件处理方法的步骤S520的流程图；图8是示出根据本公开第一实施例的与第一格式文件相对应的网站的界面；图9是示出根据本公开第一实施例的文件处理方法的步骤S700的流程图；图10是示出根据本公开第二实施例的文件处理装置的功能模块示意图；图11是示出根据本公开第二实施例的文件处理装置的生成模块820的功能模块示意图。具体实施方式下面将结合本公开实施例中的附图，对本公开实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本公开一部分实施例，而不是全部的实施例。基于本公开中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本公开保护的范围。应注意到：相似的标号和字母在下面的附图中表示类似项，因此，一旦某一项在一个附图中被定义，则在随后的附图中不需要对其进行进一步定义和解释。同时，在本公开的描述中，术语“第一”、“第二”等仅用于区分描述，而不能理解为指示或暗示相对重要性。为了管理和维护对源代码进行说明性的文档，开发人员可以采用手动维护文档的方式，即可以安排专门的人员分别源代码以及对源代码进行本文档来自技高网...

【技术保护点】
1.一种文件处理方法，包括：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。

【技术特征摘要】
1.一种文件处理方法，包括：获得与源代码相关联的第一格式文件，所述第一格式文件中包括用于对所述源代码进行说明的内容；基于所述第一格式文件生成网站源码文件，所述网站源码文件与链接地址相对应；将所述网站源码文件部署到服务器上，使得通过所述链接地址能够访问所述用于对所述源代码进行说明的内容。2.根据权利要求1所述的方法，其中，基于所述第一格式文件生成网站源码文件包括：接收生成指令；根据所述生成指令基于所述第一格式文件生成网站源码文件。3.根据权利要求1所述的方法，其中，所述根据所述生成指令基于所述第一格式文件生成网站源码文件包括：根据生成指令将所述第一格式文件转换为第二格式文件；基于所述第二格式文件以及与网站生成有关的文件生成网站源码文件。4.根据权利要求3所述的方法，其中，所述第一格式文件包括markdown格式文件，所述第二格式文件包括html格式文件，所述与网站生成有关的文件包括react壳、page.json文件以及router.js文件中的一种或多种。5.根据权利要求1所述的方法，其中，所述将所述网站源码文件部署到服务器上包括：将网站源码文件上传到源码文件管理平台，以触发所述源码文件管理平台将所述网站源码文...

【专利技术属性】
技术研发人员：胡城，
申请(专利权)人：北京拜克洛克科技有限公司，
类型：发明
国别省市：北京,11