[发明专利]二进制协议图例生成方法、装置、电子设备及存储介质

说明书

本申请实施例适用于计算机技术领域，公开了一种二进制协议图例生成方法、装置、电子设备及计算机可读存储介质，该方法包括：获取待处理二进制协议文本；针对待处理二进制协议文本中的每一行文本数据，基于预设文本描述规则对文本数据进行数据结构填充，得到处理后的文本数据；通过遍历每一行处理后的文本数据以生成HTML表格语句；基于HTML表格语句生成HTML表格，该HTML表格为待处理二进制协议文本的HTML形式的二进制协议图例。可见，本申请实施例基于预设文本描述规则快速生成二进制协议图例，使得生成二进制协议图例的操作更简便，效率更高。

技术领域

本申请属于计算机技术领域，尤其涉及一种二进制协议图例生成方法、装置、电子设备及计算机可读存储介质。

背景技术

目前，一些工具(例如，MarkDown)允许人们使用易读易写的纯文本格式编写技术文档，并通过程序转换成格式相对丰富的XHTML(或者HTML)文档，在方便技术文章作者同时，还可以使得文章层次分明，条理清晰，更方便读者阅读。

在涉及底层协议，尤其在撰写二进制协议的专业技术文档或博客时，需要详细描述二进制协议头的组成部分，一般会提供特定表格形式的协议头描述信息，以字节或者位为单位，逐字节或者逐位描述协议的每个字段的偏移位置和占用字节数。这种形式的表格简洁、直观，有助于读者快速了解和掌握协议的细节。

现有技术中，往往通过PPT或者Word文档等方式手工制作表格，以生成二进制协议图例。但这种方式操作繁琐，效率低下。

发明内容

本申请实施例提供了一种二进制协议图例生成方法、装置、电子设备及计算机可读存储介质，可以解决现有通过手工生成二进制协议图例导致的操作繁琐，以及效率低下的问题。

第一方面，本申请实施例提供一种二进制协议图例生成方法，包括：

获取待处理二进制协议文本；

针对待处理二进制协议文本中的每一行文本数据，基于预设文本描述规则对文本数据进行数据结构填充，得到处理后的文本数据；

通过遍历每一行处理后的文本数据以生成HTML表格语句；

基于HTML表格语句生成HTML表格，HTML表格为待处理二进制协议文本的HTML形式的二进制协议图例。

由上可见，本申请实施例基于简单的预设文本描述规则即可快速便捷地生成HTML形式的二进制协议图例，相较于手工生成，其操作更简便，效率更高。

在第一方面的一些可能的实现方式中，基于预设文本描述规则，对文本数据进行数据结构填充，得到处理后的文本数据，包括：

若文本数据中的第一个字符为第一字符，且行尾字符为第二字符，则提取第一字符和第二字符之间的文字说明；

若文本数据中存在第三字符，且第三字符的左侧字符为预设关键词中的一个，第三字符的右侧字符为纯数字，则提取第三字符的右侧字符；

若文本数据中存在第四字符，且第四字符的左侧字符与正则表达式匹配，第四字符的右侧字符为预设字符中的一个，则设置字段标记位。

在第一方面的一些可能的实现方式中，第一字符为[，第二字符为]，第三字符为等号，第四字符为逗号；

预设关键词包括unit、cols和width，预设字符包括*、～和+。

在第一方面的一些可能的实现方式中，通过遍历每一行处理后的文本数据以生成HTML表格语句，包括：

遍历每一行处理后的文本数据，得到每一行的遍历结果；

基于每一行的遍历结果生成HTML表格语句；

其中，遍历每一行处理后的文本数据的过程包括：