CN112307404A

CN112307404A - 基于源文件的文档网站的设置方法、装置、设备及介质

Info

Publication number: CN112307404A
Application number: CN202011264007.6A
Authority: CN
Inventors: 朱雷; 乐亚平; 邵海波
Original assignee: Shandong Yunhai Guochuang Cloud Computing Equipment Industry Innovation Center Co Ltd
Current assignee: Shandong Yunhai Guochuang Cloud Computing Equipment Industry Innovation Center Co Ltd
Priority date: 2020-11-12
Filing date: 2020-11-12
Publication date: 2021-02-02

Abstract

本申请公开了一种基于源文件的文档网站的设置方法，包括：扫描源文件并提取源文件中的注释信息和代码段；利用预设脚本分析注释信息和代码段，并将对应的分析结果存储于结构树中；根据结构树生成中间文件格式的中间文件，并根据中间文件输出对应的目标文档网站。本方法利用计算机程序实现设置目标文档网站的过程，避免了现有技术中通过工程师手动输入操作得出目标格式文档以及根据目标格式文档手动设置目标文档网站的过程，根据源文件提取出的结构树生成目标文档网站，能够提高设置文档网站的便捷度和效率，提高文档网站内容的同步性和准确度。本申请还公开了一种基于源文件的文档网站的设置装置、设备及计算机可读存储介质，均具有上述有益效果。

Description

基于源文件的文档网站的设置方法、装置、设备及介质

技术领域

本发明涉及文档设置领域，特别涉及一种基于源文件的文档网站的设置方法、装置、设备及计算机可读存储介质。

背景技术

随着大规模集成电路系统设计的飞速发展，集成电路规模越来越大，芯片自身复杂度也日渐复杂。在芯片开发设计的各个阶段中，都需要使用文档在各个团队之间交互。如图1所示，为目前在芯片开发设计过程中所需要输出的文档的示意图，需要输出的文档包括需求文档、系统架构文档等。也就是说，从芯片架构、设计到验证，再到后端的过程中，需要根据芯片开发设计周期设置对应的文档，并保持代码和文档的同步，并且为了进一步提高文档的可读性和便捷性，需要根据目标格式文档设置对应的目标文档网站，以借助网站插件实现网站搜索，语法高亮，页码跳转等功能。

现有技术中，一般是工程师根据源文件中用于描述代码的基本功能及属性的注释进行手动编写文档，得出目标格式文档，并将目标格式文档导入预设网站模板中，以输出对应的目标文档网站。显然，现有技术中设置目标文档网站方法，不仅操作过程繁琐，效率低，目标文档网站的内容与源文件中的内容无法同步，而且工程师在编写目标格式文档的过程中时常有笔误的情况，使得设置出的目标文档网站的内容不准确。

因此，如何提高设置文档网站的便捷度和效率，提高文档网站内容的同步性和准确度，是本领域技术人员目前需要解决的技术问题。

发明内容

有鉴于此，本发明的目的在于提供一种基于源文件的文档网站的设置方法，能够提高设置文档网站的便捷度和效率，提高文档网站内容的同步性和准确度；本发明的另一目的是提供一种基于源文件的文档网站的设置装置、设备及计算机可读存储介质，均具有上述有益效果。

为解决上述技术问题，本发明提供一种基于源文件的文档网站的设置方法，包括：

扫描源文件并提取所述源文件中的注释信息和代码段；

利用预设脚本分析所述注释信息和所述代码段，并将对应的分析结果存储于结构树中；

根据所述结构树生成中间文件格式的中间文件，并根据所述中间文件输出对应的目标文档网站。

优选地，在所述根据所述结构树生成中间文件格式的中间文件之后，进一步包括：

根据所述中间文件输出对应的目标格式文件。

优选地，在所述根据所述结构树生成中间文件格式的中间文件，并根据所述中间文件输出对应的目标文档网站之后，进一步包括：

将所述目标文档网站的网站资源数据上传至远端服务器。

优选地，在所述利用预设脚本分析所述注释信息和所述代码段，并将对应的分析结果存储于结构树中之后，进一步包括：

根据所述结构树中的节点的类继承关系设置对应的类继承树。

优选地，进一步包括：

利用版本管理工具管理所述目标文档网站的所述网站资源数据。

优选地，所述根据所述中间文件输出对应的目标文档网站的过程，具体包括：

利用CSS设置网页形式；

将所述中间文件输入至静态网站生成框架，并输出对应的目标文档网站。

优选地，所述扫描源文件并提取所述源文件中的注释信息和代码段的过程，具体包括：

按照预设时间周期扫描所述源文件并提取所述源文件中的所述注释信息和所述代码段。

为解决上述技术问题，本发明还提供一种基于源文件的文档网站的设置装置，包括：

扫描模块，用于扫描源文件并提取所述源文件中的注释信息和代码段；

分析模块，用于利用预设脚本分析所述注释信息和所述代码段，并将对应的分析结果存储于结构树中；

第一输出模块，用于根据所述结构树生成中间文件格式的中间文件，并根据所述中间文件输出对应的目标文档网站。

为解决上述技术问题，本发明还提供一种基于源文件的文档网站的设置设备，包括：

存储器，用于存储计算机程序；

处理器，用于执行所述计算机程序时实现上述任一种基于源文件的文档网站的设置方法的步骤。

为解决上述技术问题，本发明还提供一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现上述任一种基于源文件的文档网站的设置方法的步骤。

本发明提供的一种基于源文件的文档网站的设置方法，通过扫描源文件并提取源文件中的注释信息和代码段；利用预设脚本分析注释信息和代码段，并将对应的分析结果存储于结构树中；然后根据结构树生成中间文件格式的中间文件，并根据中间文件输出对应的目标格式文档；本方法利用计算机程序实现设置目标文档网站的过程，避免了现有技术中通过工程师手动输入操作得出目标格式文档以及根据目标格式文档手动设置目标文档网站的过程，因此能够大大提高设置目标文档网站的便捷度和效率；并且，由于本方法中的中间文件是根据源文件提取出的结构树生成，因此当源文件中的注释信息和代码段更新时，将对应更新中间文件以及目标文档网站，从而保证了芯片开发周期各个阶段的源文件和目标文档网站的内容同步；此外，本方法通过避免手动输入的过程，能够避免手动输入的笔误，从而提高目标文档网站内容的准确度。

为解决上述技术问题，本发明还提供了一种基于源文件的文档网站的设置装置、设备及计算机可读存储介质，均具有上述有益效果。

附图说明

为了更清楚地说明本发明实施例或现有技术的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单的介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。

图1为目前在芯片开发设计过程中所需要输出的文档的示意图；

图2为本发明实施例提供的一种基于源文件的文档网站的设置方法的流程图；

图3为本发明实施例提供的一种以Verilog语言为例的注释结构的示意图；

图4为本发明实施例提供的一种具体的结构树的示意图；

图5为本发明实施例提供的一种根据Markdown模板对应生成的Markdown文件的示意图；

图6为本发明实施例提供的另一种基于源文件的文档网站的设置方法的过程示意图；

图7为本发明实施例提供的一种基于UVM的平台类继承树的结构示意图；

图8为本发明实施例提供的一种基于源文件的文档网站的设置装置的结构图；

图9为本发明实施例提供的一种基于源文件的文档网站的设置设备的结构图。

具体实施方式

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

本发明实施例的核心是提供一种基于源文件的文档网站的设置方法，能够提高设置文档网站的便捷度和效率，提高文档网站内容的同步性和准确度；本发明的另一核心是提供一种基于源文件的文档网站的设置装置、设备及计算机可读存储介质，均具有上述有益效果。

为了使本领域技术人员更好地理解本发明方案，下面结合附图和具体实施方式对本发明作进一步的详细说明。

图2为本发明实施例提供的一种基于源文件的文档网站的设置方法的流程图。如图2所示，一种基于源文件的文档网站的设置方法包括：

S10：扫描源文件并提取源文件中的注释信息和代码段。

具体的，首先根据源文件后的缀识别语言类型，再根据对应的语言类型扫描源文件，提取源文件中的注释信息和代码段。

需要说明的是，本实施例中源文件的语言类型可以是芯片开发设计、验证以及后端流程中使用的程序语言，包括Verilog/SystemVerilog、，VHDL(超高速集成电路硬件描述语言)，C/C++，Python，Perl，TCL(脚本语言)等，本实施例对此不做限定，另外源文件还可以是用户增加的自定义语言类型，利用相应类型语言的Parser(解析器)以实现注释信息和代码段的提取。

具体的，使用脚本语言的字符串处理函数或预设的正则表达式对各种源文件进行处理，首先检测出源文件中的与预设键对格式相同的键对，并判断检测出的键对中的关键字是否存在于预设支持列表之中，若是，则获取该键对后对应的注释信息和代码段，并将注释信息存储于结构树的“描述”字段中，将紧跟注释之后的代码段存储于结构树的“代码”字段中。更具体的，如表1为本实施例提供的不同语言类型对应的注释符；如表2为本实施例提供的部分关键字与对应的描述；一种以Verilog语言为例的注释结构如图3所示。

表1不同语言类型对应的注释符

语言类型	注释符
		Verilog/SystemVerilog	//
VHDL	--
		SpinalHDL	//
C	//
		C++	//
Python	#
		Perl	#
TCL	#

表2关键字与对应的描述

关键字	描述
		Class	类
Function	函数
		Task	任务
Variable	变量
		Signal	信号
Interface	接口
		Module	模块
Constraint	约束
		Macro	宏
Typedef	自定义类型
		Enum	枚举

需要说明的是，表2所示的关键字与对应的描述并不作为本实施例的限定，在实际操作中，也支持用户加入自定义的关键字以及对应的描述，并且支持对这些自定义关键字的处理。

S20：利用预设脚本分析注释信息和代码段，并将对应的分析结果存储于结构树中。

具体的，一种具体的结构树的示意图如图4所示。在本步骤中，在将注释信息和代码段存储于结构树中之后，依据子节点类型及语言类型，对节点中的注释信息和代码段进行语法分析和语义分析，例如类的父类，是否为虚基类；变量的访问权限，类型，默认值，是否可随机化；函数的生命周期，返回值，参数列表等，分析结束后，将对应的分析结果更新到结构树中。

S30：根据结构树生成中间文件格式的中间文件，并根据中间文件输出对应的目标文档网站。

具体的，将结构树中的信息渲染成中间文件格式的中间文件，再根据中间文件输出对应的目标文档网站。本实施例中，中间文件格式的中间文件具体为Markdown文件。在实际操作中，首先根据不同语言类型对应的语法结构设置Markdown模板，然后使用结构树中保存的信息对Markdown模板进行渲染，最终生成Markdown文件。更具体的，一种基于UVM的Markdown模板如下所示，根据该Markdown模板对应生成的Markdown文件的示意图如图5所示。

{#一级标题：描述#}

#Description

{#类的描述#}

{#类的继承关系#}

**Inherits**:``{{sv_class['parent']}}``

{#类的约束#}

{％if'constraint'in sv_class['groups']％}

{#一级标题：约束#}

#Constraint

{％for constraint in sv_class['constraint']％}

{#二级标题：约束名#}

##{{constraint['name']}}

{#约束描述#}

**Description**:

{#约束体#}

```verilog

```

{％endfor％}

{％endif％}

……

本发明实施例提供的一种基于源文件的文档网站的设置方法，通过扫描源文件并提取源文件中的注释信息和代码段；利用预设脚本分析注释信息和代码段，并将对应的分析结果存储于结构树中；然后根据结构树生成中间文件格式的中间文件，并根据中间文件输出对应的目标格式文档；本方法利用计算机程序实现设置目标文档网站的过程，避免了现有技术中通过工程师手动输入操作得出目标格式文档以及根据目标格式文档手动设置目标文档网站的过程，因此能够大大提高设置目标文档网站的便捷度和效率；并且，由于本方法中的中间文件是根据源文件提取出的结构树生成，因此当源文件中的注释信息和代码段更新时，将对应更新中间文件以及目标文档网站，从而保证了芯片开发周期各个阶段的源文件和目标文档网站的内容同步；此外，本方法通过避免手动输入的过程，能够避免手动输入的笔误，从而提高目标文档网站内容的准确度。

在上述实施例的基础上，本实施例对技术方案作了进一步的说明和优化，具体的，本实施例在根据结构树生成中间文件格式的中间文件之后，进一步包括：

根据中间文件输出对应的目标格式文件。

具体的，如图6所示，为本发明实施例提供的另一种基于源文件的文档网站的设置方法的过程示意图。具体的，目标格式文件具体包括html、doc和pdf等格式的文件，即可以将Markdown文件转换为html、doc和pdf等格式的文件。需要说明的是，在本实施例中，具体可以通过Pandoc工具将Markdown文件输出成为doc或者pdf格式，并且可以将Pandoc工具的python版本与本方法对应的系统进行集成，输出期望的目标格式文件。

同时，由于Markdown文件是根据源文件提取出的结构树生成，因此当源文件中的注释信息和代码段更新时，其对应的Markdown文件也实时更新，对应的目标格式文件也将实时更新，从而保证了芯片开发周期各个阶段的源文件和目标格式文件内容的同步性和一致性。

需要说明的是，本实施例通过进一步获取目标格式文件，更便于存储传输。

在上述实施例的基础上，本实施例对技术方案作了进一步的说明和优化，具体的，本实施例在根据结构树生成中间文件格式的中间文件，并根据中间文件输出对应的目标文档网站之后，进一步包括：

将目标文档网站的网站资源数据上传至远端服务器。

在本实施例中，是进一步将目标文档网站的网站资源数据通过版本管理工具上传到远端服务器中，对应的，通过在远端服务器启动运行该目标文档网站，以实现在客户端可以远程访问目标文档网站的功能。需要说明的是，网站资源数据包括配置文件、Markdown文件以及目录结构要求等文件；客户端在启动目标文档网站之后，也可以根据Markdown文件是否更新来刷新页面，无需重启操作即可更新网页内容，便捷地保障目标文档网站内容与源文件内容的一致性和同步性。

可见，本实施例通过进一步将目标文档网站的网站资源数据上传至远端服务器，能够远程访问目标文档网站，进一步提高信息查看的便捷性。

在上述实施例的基础上，本实施例对技术方案作了进一步的说明和优化，具体的，本实施例在利用预设脚本分析注释信息和代码段，并将对应的分析结果存储于结构树中之后，进一步包括：

根据结构树中的节点的类继承关系设置对应的类继承树。

需要说明的是，由于目标文档网站的网页需要支持本地类型跳转及祖先函数展开，因此还需要将类的继承关系保存为另一颗继承树，因此本实施例进一步包括根据结构树中的节点的类继承关系设置对应的类继承树。并且，在实际操作中，在类继承树中可以预定义一部分节点，以防止节点的离散，例如芯片验证中基于UVM(Universal VerificationMethodology，通用验证方法学)的平台下，可以将UVM原生节点预定义到树中，再逐步加入解析出来的类信息。具体的，图7为本发明实施例提供的一种基于UVM的平台类继承树的结构示意图，如图7所示，其中灰色节点是预定义的原生节点，白色节点是从用户平台中提取的节点。

可见，本实施例通过进一步设置类继承树，能够在目标文档网站的页面上操作跳转该节点的上一类或者其他类，以及将该节点至祖先节点的信息展示出来，能够进一步提高信息查看的便捷性。

在上述实施例的基础上，本实施例对技术方案作了进一步的说明和优化，具体的，本实施例进一步包括：

利用版本管理工具管理目标文档网站的网站资源数据。

需要说明的是，在本实施例中，进一步利用版本管理工具管理目标文档网站的网站资源数据。

具体的，利用版本管理工具实现对网站资源数据的操作权限的管理，只授予特定人员拥有对网站资源数据的操作权限。具体的，在对用户身份进行身份验证之后，在验证通过的情况下才能够对网站资源数据进行修改传输等操作。因此本方法能够提高得出目标文档网站的信息安全性和可靠性。可以理解的是，采用版本管理工具管理网站资源数据还具有操作简便，版本可追溯，易于控制权限，用户学习成本低等优点。

在上述实施例的基础上，本实施例对技术方案作了进一步的说明和优化，具体的，本实施例中，根据中间文件输出对应的目标文档网站的过程，具体包括：

利用CSS设置网页形式；

将中间文件输入至静态网站生成框架，并输出对应的目标文档网站。

具体的，在本实施例中，首先通过CSS(Cascading Style Sheets，层叠样式表)控制各个网页组件(例如插件，侧边栏，标题，列表，主体等)的位置，状态，设置网页形式；然后将Markdown文件导入静态网站生成框架中，利用静态网站生成框架输出对应的目标文档网站。需要说明的是，利用静态网页生成框架生成目标文档网站，能够借助预设网站插件实现网站内容搜索，语法高亮，页码跳转等功能，增加了目标文档网站的可读性和便捷性。

可见，本实施例通过将中间文件输入至静态网站生成框架，并输出对应的目标文档网站，可以使得目标文档网站的网页形式的灵活性更高，增加了目标文档网站的可读性和便捷性。

在上述实施例的基础上，本实施例对技术方案作了进一步的说明和优化，具体的，本实施例中，扫描源文件并提取源文件中的注释信息和代码段的过程，具体包括：

按照预设时间周期扫描源文件并提取源文件中的注释信息和代码段。

在实际操作中，可以按照预设时间周期或者预设关键时间点扫描源文件以得出目标文档网站。本实施例中优选地是按照预设时间周期扫描源文档。具体的，预设时间周期根据实际需求设置，本实施例对预设时间周期的具体时长不做限定。

本实施例通过按照预设时间周期扫描源文件并提取源文件中的注释信息和代码段，即周期性地进行更新目标文档网站，能够及时保持源文件和目标文档网站的同步性和一致性，便于用户实时查看。

上文对于本发明提供的一种基于源文件的文档网站的设置方法的实施例进行了详细的描述，本发明还提供了一种与该方法对应的基于源文件的文档网站的设置装置、设备及计算机可读存储介质，由于装置、设备及计算机可读存储介质部分的实施例与方法部分的实施例相互照应，因此装置、设备及计算机可读存储介质部分的实施例请参见方法部分的实施例的描述，这里暂不赘述。

图8为本发明实施例提供的一种基于源文件的文档网站的设置装置的结构图，如图8所示，一种基于源文件的文档网站的设置装置包括：

扫描模块81，用于扫描源文件并提取源文件中的注释信息和代码段；

分析模块82，用于利用预设脚本分析注释信息和代码段，并将对应的分析结果存储于结构树中；

第一输出模块83，用于根据结构树生成中间文件格式的中间文件，并根据中间文件输出对应的目标文档网站。

本发明实施例提供的基于源文件的文档网站的设置装置，具有上述基于源文件的文档网站的设置方法的有益效果。

作为优选的实施方式，一种基于源文件的文档网站的设置装置进一步包括：

第二输出模块，用于根据中间文件输出对应的目标格式文件。

上传模块，用于将目标文档网站的网站资源数据上传至远端服务器。

设置模块，用于根据结构树中的节点的类继承关系设置对应的类继承树。

管理模块，用于利用版本管理工具管理目标文档网站的网站资源数据。

图9为本发明实施例提供的一种基于源文件的文档网站的设置设备的结构图，如图9所示，一种基于源文件的文档网站的设置设备包括：

存储器91，用于存储计算机程序；

处理器92，用于执行计算机程序时实现如上述基于源文件的文档网站的设置方法的步骤。

本发明实施例提供的基于源文件的文档网站的设置设备，具有上述基于源文件的文档网站的设置方法的有益效果。

为解决上述技术问题，本发明还提供一种计算机可读存储介质，计算机可读存储介质上存储有计算机程序，计算机程序被处理器执行时实现如上述基于源文件的文档网站的设置方法的步骤。

本发明实施例提供的计算机可读存储介质，具有上述基于源文件的文档网站的设置方法的有益效果。

以上对本发明所提供的基于源文件的文档网站的设置方法、装置、设备及计算机可读存储介质进行了详细介绍。本文中应用了具体实施例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想。应当指出，对于本技术领域的普通技术人员来说，在不脱离本发明原理的前提下，还可以对本发明进行若干改进和修饰，这些改进和修饰也落入本发明权利要求的保护范围内。

说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

专业人员还可以进一步意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、计算机软件或者二者的结合来实现，为了清楚地说明硬件和软件的可互换性，在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本发明的范围。

Claims

1.一种基于源文件的文档网站的设置方法，其特征在于，包括：

扫描源文件并提取所述源文件中的注释信息和代码段；

2.根据权利要求1所述的方法，其特征在于，在所述根据所述结构树生成中间文件格式的中间文件之后，进一步包括：

根据所述中间文件输出对应的目标格式文件。

3.根据权利要1所述的方法，其特征在于，在所述根据所述结构树生成中间文件格式的中间文件，并根据所述中间文件输出对应的目标文档网站之后，进一步包括：

将所述目标文档网站的网站资源数据上传至远端服务器。

4.根据权利要求1所述的方法，其特征在于，在所述利用预设脚本分析所述注释信息和所述代码段，并将对应的分析结果存储于结构树中之后，进一步包括：

5.根据权利要求3所述的方法，其特征在于，进一步包括：

6.根据权利要求1所述的方法，其特征在于，所述根据所述中间文件输出对应的目标文档网站的过程，具体包括：

利用CSS设置网页形式；

7.根据权利要求1至6任一项所述的方法，其特征在于，所述扫描源文件并提取所述源文件中的注释信息和代码段的过程，具体包括：

8.一种基于源文件的文档网站的设置装置，其特征在于，包括：

9.一种基于源文件的文档网站的设置设备，其特征在于，包括：

存储器，用于存储计算机程序；

处理器，用于执行所述计算机程序时实现如权利要求1至7任一项所述的基于源文件的文档网站的设置方法的步骤。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现如权利要求1至7任一项所述的基于源文件的文档网站的设置方法的步骤。