[发明专利]一种注释填充方法

说明书

本发明提供一种注释填充方法，包括：S1，对于目标文件中的任意一行内容，若该行内容中含有未被注释的函数，则根据所述函数从预先构建的注释字典中提取对应的注释，并将所述注释插入该行与前一行之间。本发明提供的一种注释填充方法，通过提取文件中未被注释的函数，并根据注释字典填充函数，实现了注释的自动填充，节省了人力成本和时间成本，增强了代码的可读性。

技术领域

本发明涉及互联网移动端应用开发技术领域，尤其涉及一种注释填充方法。

背景技术

随着手机移动端的快速发展，移动端应用在人们的日常生活中发挥了越来越重要的作用。

在移动端的开发过程中，很多时候需要为项目添加注释。添加注释主要具备两点优势，一是方便其他开发人员阅读代码，快速了解函数的作用和功能，进而便利代码的修改和维护，二是方便代码开发人员自身加深对函数功能的理解。

注释由两部分组成，一部分是注释符号，一部分是注释内容。其中，注释符号的模式一般固定为都是双斜杠。以单个文件中的函数为例，每个函数都具备所述函数的声明和实现，在声明和实现中都需要添加注释：如果函数的实现添加了注释，而函数的声明没有添加注释，则可以将注释自动填充到声明中；如果函数的声明添加了注释，而函数的实现没有添加注释，则可以自动将声明的注释添加到实现中。常规的方案是采用复制粘贴进行操作，在工程中包括了大量文件和大量函数时，人工操作不仅费时费力，而且容易出现遗漏。

发明内容

本发明为解决现有技术中存在的问题，提供了一种注释填充方法。

一方面，本发明提出一种注释填充方法，包括：S1，对于目标文件中的任意一行内容，若该行内容中含有未被注释的函数，则根据所述函数从预先构建的注释字典中提取对应的注释，并将所述注释插入该行与前一行之间。

优选地，所述注释字典的构建方法包括：s1，对于素材文件的任意一行内容，若该行内容中含有函数，且前一行内容或前两行内容中含有所述函数对应的注释，则将所述函数与注释对应保存在所述注释字典中。

优选地，还包括：S0，根据目标文件夹目录获取所述目标文件夹下任一目标文件的路径，根据所述路径打开该目标文件。

优选地，所述步骤S1进一步包括：S11，对于目标文件中的任意一行内容，若该行内容中含有函数标识，则确认该行内容中含有函数；S12，若该行内容与前一行内容中不含有注释标识，则确认所述函数未被注释；S13，根据所述函数从预先构建的注释字典中提取对应的注释，将所述注释插入该行与前一行之间。

优选地，所述步骤s1进一步包括：s11，对于所述素材文件中的任意一行内容，若该行内容中含有函数标识，则确认该行内容中含有函数；s12，若前一行内容或前两行内容中含有注释标识，则确认所述前一行内容或前两行内容中含有所述函数对应的注释；s13，将所述函数和注释对应保存在所述注释字典中。

优选地，所述步骤S0进一步包括：S01，将目标文件夹目录输入os.walk模块，应用for循环遍历所述目标文件夹，获取所述目标文件夹下的每一目标文件的文件名和目录；S02，拼接任一所述目标文件的文件名和目录，获取所述任一目标文件的路径，根据所述路径打开所述任一目标文件。

优选地，所述步骤S13进一步包括：将所述函数作为键，输入字典模型中，将从所述预先构建的注释字典中返回的所述键对应的值作为所述函数对应的注释，将所述注释插入该行与前一行之间。

优选地，所述步骤s13进一步包括：提取该行内容，删除该行内容中的函数标识，获取该行内容中的函数；提取前一行内容或前两行内容，删除前一行内容或前两行内容中的注释标识，获取所述函数对应的注释；应用字典模型将所述函数作为键、对应的注释作为值保存在所述注释字典中。