CN108196841A - 注释符号添加方法、装置及电子设备 - Google Patents

Abstract

本发明实施例涉及互联网技术领域，提供一种注释符号添加方法、装置及电子设备，所述方法包括：接收注释符号添加请求；依据注释符号添加请求，获取待添加注释符号的第一文件；调用预先建立的添加注释符号函数，为第一文件添加注释符号。与现有技术相比，本发明实施例可以自动为待添加注释的第一文件加上注释符号，效率高且实用性强。

Description

注释符号添加方法、装置及电子设备

技术领域

本发明涉及互联网技术领域，具体而言，涉及一种注释符号添加方法、装置及电子设备。

背景技术

随着手机移动端的快速发展，在开发过程中很多时候需要为项目添加注释符号。添加注释符号有两个好处：一是方便别人阅读代码，快速知道一个函数的作用和功能，进而方便修改代码；第二个好处是方便自己加深对功能的理解。注释由两部分组成：一部分是注释符号，另一部分是注释内容。注释符号一般模式都比较固定，一般都是双斜杠，或者由斜杠和※号组成，在开发中注释符号需要为每个函数生成，属于一个重复的工作。

发明内容

本发明实施例的目的在于提供一种注释符号添加方法、装置及电子设备，用以自动添加注释符号。

为了实现上述目的，本发明实施例采用的技术方案如下：

第一方面，本发明实施例提供了一种注释符号添加方法，所述方法包括：接收注释符号添加请求；依据所述注释符号添加请求，获取待添加注释符号的第一文件；调用预先建立的添加注释符号函数，为所述第一文件添加注释符号。

第二方面，本发明实施例还提供了一种注释符号添加装置，所述装置包括请求接收模块、第一文件获取模块和注释符号添加模块。其中，请求接收模块用于接收注释符号添加请求；第一文件获取模块用于依据所述注释符号添加请求，获取待添加注释符号的第一文件；注释符号添加模块用于调用预先建立的添加注释符号函数，为所述第一文件添加注释符号。

第三方面，本发明实施例还提供了一种电子设备，所述电子设备包括：存储器；处理器；以及注释符号添加装置，所述注释符号添加装置存储于所述存储器中并包括一个或多个由所述处理器执行的软件功能模组。所述装置包括请求接收模块、第一文件获取模块和注释符号添加模块。其中，请求接收模块用于接收注释符号添加请求；第一文件获取模块用于依据所述注释符号添加请求，获取待添加注释符号的第一文件；注释符号添加模块用于调用预先建立的添加注释符号函数，为所述第一文件添加注释符号。

相对现有技术，本发明实施例提供的一种注释符号添加方法、装置及电子设备，首先，接收注释符号添加请求；然后，依据所述注释符号添加请求，获取待添加注释符号的第一文件；最后，调用预先建立的添加注释符号函数，为所述第一文件添加注释符号。与现有技术相比，本发明实施例可以自动为待添加注释的第一文件加上注释符号，效率高且实用性强。

为使本发明的上述目的、特征和优点能更明显易懂，下文特举较佳实施例，并配合所附附图，作详细说明如下。

附图说明

为了更清楚地说明本发明实施例的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，应当理解，以下附图仅示出了本发明的某些实施例，因此不应被看作是对范围的限定，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他相关的附图。

图1示出了本发明实施例提供的电子设备的方框示意图。

图2示出了本发明第一实施例提供的注释符号添加方法流程图。

图3为图2示出的步骤S102的子步骤流程图。

图4为图2示出的步骤S103的子步骤流程图。

图5示出了本发明第二实施例提供的注释符号添加装置的方框示意图。

图标：100-电子设备；101-存储器；102-存储控制器；103-处理器；104-外设接口；105-显示屏；200-注释符号添加装置；201-请求接收模块；202-第一文件获取模块；203-注释符号添加模块。

具体实施方式

下面将结合本发明实施例中附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。通常在此处附图中描述和示出的本发明实施例的组件可以以各种不同的配置来布置和设计。因此，以下对在附图中提供的本发明的实施例的详细描述并非旨在限制要求保护的本发明的范围，而是仅仅表示本发明的选定实施例。基于本发明的实施例，本领域技术人员在没有做出创造性劳动的前提下所获得的所有其他实施例，都属于本发明保护的范围。

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

请参照图1，图1示出了本发明较佳实施例提供的电子设备100的方框示意图。电子设备100可以是，但不限于智能手机、平板电脑、膝上型便携计算机、笔记本电脑、台式机等等。所述电子设备100包括注释符号添加装置200、存储器101、存储控制器102、处理器103、外设接口104和显示屏105。

所述存储器101、存储控制器102、处理器103、外设接口104和显示屏105各元件相互之间直接或间接地电性连接，以实现数据的传输或交互。例如，这些元件相互之间可通过一条或多条通讯总线或信号线实现电性连接。所述注释符号添加装置200包括至少一个可以软件或固件(firmware)的形式存储于所述存储器101中或固化在所述电子设备100的操作系统(operating system，OS)中的软件功能模块。所述处理器103用于执行存储器101中存储的可执行模块，例如所述注释符号添加装置200包括的软件功能模块或计算机程序。

其中，存储器101可以是，但不限于，随机存取存储器(Random Access Memory，RAM)，只读存储器(Read Only Memory，ROM)，可编程只读存储器(Programmable Read-OnlyMemory，PROM)，可擦除只读存储器(Erasable Programmable Read-Only Memory，EPROM)，电可擦除只读存储器(Electric Erasable Programmable Read-Only Memory，EEPROM)等。其中，存储器101用于存储程序，所述处理器103在接收到执行指令后，执行所述程序。

处理器103可以是一种集成电路芯片，具有信号处理能力。上述的处理器103可以是通用处理器，包括中央处理器(Central Processing Unit，CPU)、网络处理器(NetworkProcessor，NP)、语音处理器以及视频处理器等；还可以是数字信号处理器、专用集成电路、现场可编程门阵列或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件。可以实现或者执行本发明实施例中的公开的各方法、步骤及逻辑框图。通用处理器可以是微处理器或者该处理器103也可以是任何常规的处理器等。

所述外设接口104用于将各种输入/输出装置耦合至处理器103以及存储器101。在一些实施例中，外设接口104、处理器103以及存储控制器102可以在单个芯片中实现。在其他一些实例中，他们可以分别由独立的芯片实现。

显示屏105用于实现用户与电子设备100之间的交互，具体可以是，但不限于用户通过显示屏105输入注释符号添加请求，以及显示屏105将添加注释后的第一文件进行显示。

第一实施例

请参照图2，图2示出了本发明较佳实施例提供的自动注释符号添加方法流程图。搜索关键词的处理方法包括以下步骤：

步骤S101，接收注释符号添加请求。

在本发明实施例中，注释符号添加请求可以是用户基于显示屏105发送的注释符号请求，用户可以通过注释符号添加请求为指定文件夹下的所有文件添加注释符号、或者为指定文件添加注释符号。作为一种实施方式，可以通过添加打印信息来告知用户选择待添加注释符号的文件夹或者文件，用户可以根据打印信息选择待添加注释符号的文件夹或者文件，例如，用户可以输入1为指定文件夹下的所有文件添加注释符号，输入2为指定文件添加注释符号。待添加注释符号的文件夹或者文件确定之后，再提示用户输入待添加注释符号的文件夹或者文件的存储地址，以根据存储地址获取待添加注释符号的文件夹或者文件。

步骤S102，依据所述注释符号添加请求，获取待添加注释符号的第一文件。

在本发明实施例中，注释符号添加请求包括存储地址，例如，F:\aaa、F:\aaa\1.m等。获取到注释符号添加请求之后，首先要根据存储地址判断注释符号添加请求对应的是文件夹还是文件。

作为一种实施方式，当存储地址为文件路径时，则表示用户选择为该文件路径对应的文件添加注释符号，则依据存储地址，获取文件路径对应的文件，例如，F:\aaa\1.m对应的文件1.m，并将该文件作为待添加注释符号的第一文件。

作为另一实施方式，当存储地址为文件夹路径时，请参照图3，步骤S102可以包括以下子步骤：

子步骤S1021，依据存储地址，获取文件夹路径对应的文件夹。

在本发明实施例中，当存储地址为文件夹路径时，则表示用户选择为该文件夹路径下对应的文件夹下的所有文件均添加注释符号，则依据存储地址，获取文件夹路径对应的文件夹，例如，F:\aaa对应的文件夹aaa。

子步骤S1022，遍历文件夹，获取文件夹下的所有文件，并将文件夹下的所有文件均作为待添加注释符号的第一文件。

在本发明实施例中，获取到文件夹路径对应的文件夹之后，对该文件夹进行遍历，获取该文件夹下的所有文件，例如，F:\aaa对应的文件夹aaa中包括文件1.m、2.m、3.m、以及文件夹4，其中，文件夹4中包括文件5.m、6.m、7.m，则需要遍历件夹aaa，获取到文件夹下的所有文件。

在本发明实施例中，可以采用os.walk内容查找方法遍历文件夹，具体可以是：首先，利用os.walk内容查找方法获取一个数组，这个数组中包含当前目录root(例如，F:\aaa)、当前文件夹路径下所有的子目录dirs(例如，F:\aaa:\4)、以及当前目录下的所有非目录文件files(例如，F:\aaa:\1.m、F:\aaa:\2.m、F:\aaa:\3.m)；然后，对os.walk内容查找方法获得的数组执行循环遍历操作，这样就可以拿到每个数组元素，每个数组元素对应一个文件，得到文件夹下的所有文件，并将文件夹下的所有文件均作为待添加注释符号的第一文件。

步骤S103，调用预先建立的添加注释符号函数，为第一文件添加注释符号。

在本发明实施例中，获取到待添加注释符号的第一文件之后，可以使用获取文件后缀的方法os.path.splitext获取到每个第一文件的后缀，并通过第一文件的后缀判断第一文件是否为编程文件，例如，后缀为.h或.m或.php或.c或.cpp等，当判定第一文件为编程文件时，则调用预先建立的添加注释符号函数，为第一文件添加注释符号。

在本发明实施例中，添加注释符号函数可以用replaceFun表示，该添加注释符号函数没有返回值，且包括三个参数，一个参数是待添加注释符号的第一文件的文件地址、一个参数是头文件、一个参数是待添加注释符号的第一文件的文件名称，可以通过以下方法建立添加注释符号函数：

首先，定义第一字符串和第二字符串，第一字符串定义为oldStr，第二字符换定义为newStr，第一字符串可以是一个函数开头的前缀，例如，@等，第二字符串可以包括注释符号和第一字符串，例如，newStr＝zhushi+"\n”+oldStr，其中，zhushi为一个变量，用于存储注释符号，注释符号的样式可以是，但不限于双斜杠形式、多行注释形式等等，注释符号的具体样式可以由用户根据实际需要灵活调整，在本发明实施例中，注释符号可以设置为多行注释形式，即/***/，将/***/作为一个字符串保存在变量zhushi中，后续若需要修改注释符号的样式，则只需要修改变量zhushi对应的内容即可，无需修改代码，可以很方便的修改注释符号的样式。

然后，依据第一预设条件，定位第一文件中的待添加注释符号行，第一预设条件可以是待添加注释符号行为函数行，且待添加注释符号行、以及与待添加注释符号行连续的上一行均没有注释符号，函数行可以根据是否包含函数前缀来进行判断，注释符号可以是双斜杠形式、多行注释形式中的任意一种。

接下来，定位到待添加注释符号行之后，获取待添加函数行中的第一字符串，也就是函数前缀，并利用第二字符串替换第一字符串，以将注释符号添加到待添加注释符号行中。

作为一种实施方式，可以对第一文件进行逐行遍历，同时定义一个变量file_data来保存遍历到待添加注释符号行时保存与待添加注释符号行连续的上一行last_line的数据。因此，添加注释符号之后的第一文件保存在变量file_data中，此时利用变量file_data替换原来的第一文件，并将原来的第一文件删除，就完成了为第一文件添加注释符号的过程。为第一文件添加注释符号的过程可以用以下代码实现：

请参照图3，步骤S103可以包括以下子步骤：

子步骤S1031，依据第一预设条件，定位第一文件中的待添加注释符号行。

在本发明实施例中，获取到待添加注释符号的第一文件之后，需要遍历第一文件中定位出第一文件中的待添加注释符号行。可以通过遍历第一文件的每一行来定位出待添加注释符号行，首先，判断与当前行连续的上一行是否包含注释符号，例如，斜杠等，如果包含则说明当前行已经有注释，无需再添加注释符号；然后，判断当前行是否包含注释符号，例如，斜杠等，如果包含则说明当前行已经有注释，无需再添加注释符号；最后，判断当前行是否包含第一字符串oldStr，例如，@等，如果当前行包含oldStr，则说明当前行是一个函数。以上三个判断均为真时，表示当前行满足第一预设条件，即当前行为待添加注释行，需要添加注释符号。

子步骤S1032，获取待添加注释符号行中的第一字符串。

在本发明实施例中，定位出待添加注释行之后，获取该待添加注释行中的第一字符串，例如，@。

子步骤S1033，利用第二字符串替换第一字符串，以将注释符号添加到待添加注释符号行中，其中，第二字符串包括注释符号和第一字符串。

在本发明实施例中，利用添加注释符号函数replaceFun将第一字符串oldStr替换为第二字符串newStr，例如，

添加注释前为：

@property(nonatomic,strong)UIButton*closeBtn；

@property(nonatomic,strong)UIButton*tapAnnualEntranceBtn；

添加注释符号后为：

@property(nonatomic,strong)UIButton*closeBtn；

/**

挂件上覆盖button

*/

@property(nonatomic,strong)UIButton*tapAnnualEntranceBtn；

其中，第一字符串oldStr为@，第二字符串为：

/**

挂件上覆盖button

*/

@

子步骤S1034，遍历第一文件，为第一文件中的所有待添加注释符号行均添加注释符号。

与现有技术相比，本发明实施例具有以下有益效果：

首先，将注释符号保存在变量zhushi中，后续若需要修改注释符号的样式，则只需要修改变量zhushi对应的内容即可，无需修改代码，可以很方便的修改注释符号的样式；

其次，用户可以通过注释符号添加请求为指定文件夹下的所有文件添加注释符号、或者为指定文件添加注释符号，为用户提供多种选择；

第三，当用户选择为该文件夹路径下对应的文件夹下的所有文件均添加注释符号时，采用os.walk内容查找方法遍历文件夹，得到文件夹下的所有文件。

第四，通过第二字符串和第一字符串的替换，实现将注释符号添加至第一文件中，不会出现遗漏，并且格式统一，便于阅读。

第二实施例

请参照图5，图5示出了本发明第二实施例提供的注释符号添加装置200的方框示意图。注释符号添加装置200包括请求接收模块201、第一文件获取模块202及注释符号添加模块203。

请求接收模块201，用于接收注释符号添加请求。

在本发明实施例中，请求接收模块201可以用于执行步骤S101。

第一文件获取模块202，用于依据所述注释符号添加请求，获取待添加注释符号的第一文件。

在本发明实施例中，第一文件获取模块202可以用于执行步骤S102。

在本发明实施例中，第一文件获取模块202还可以用于执行步骤S102的子步骤S1021～S1022。

注释符号添加模块203，用于调用预先建立的添加注释符号函数，为第一文件添加注释符号。

在本发明实施例中，注释符号添加模块203可以用于执行步骤S103。

在本发明实施例中，注释符号添加模块203还可以用于执行步骤S103的子步骤S1031～S1034。

综上所述，本发明实施例提供的一种注释符号添加方法、装置及电子设备，所述方法包括：接收注释符号添加请求；依据注释符号添加请求，获取待添加注释符号的第一文件；调用预先建立的添加注释符号函数，为第一文件添加注释符号。与现有技术相比，本发明实施例可以自动为待添加注释的第一文件加上注释符号，效率高且实用性强。

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

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

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

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

Claims (10)

1.一种注释符号添加方法，其特征在于，所述方法包括：

接收注释符号添加请求；

依据所述注释符号添加请求，获取待添加注释符号的第一文件；

调用预先建立的添加注释符号函数，为所述第一文件添加注释符号。

2.如权利要求1所述的方法，其特征在于，所述注释符号添加请求包括存储路径，当存储地址为文件路径时，所述依据所述注释符号添加请求，获取待添加注释符号的第一文件的步骤，包括：

依据所述存储地址，获取所述文件路径对应的文件，并将该文件作为待添加注释符号的第一文件。

3.如权利要求1所述的方法，其特征在于，所述注释符号添加请求包括存储路径，当存储地址为文件夹路径时，所述依据所述注释符号添加请求，获取待添加注释符号的第一文件的步骤，包括：

依据所述存储地址，获取所述文件夹路径对应的文件夹；

遍历所述文件夹，获取所述文件夹下的所有文件，并将所述文件夹下的所有文件均作为待添加注释符号的第一文件。

4.如权利要求1所述的方法，其特征在于，所述调用预先建立的添加注释符号函数，为所述第一文件添加注释符号的步骤，包括：

依据第一预设条件，定位所述第一文件中的待添加注释符号行；

获取所述待添加注释符号行中的第一字符串；

利用第二字符串替换所述第一字符串，以将注释符号添加到所述待添加注释符号行中，其中，所述第二字符串包括注释符号和第一字符串；

遍历所述第一文件，为所述第一文件中的所有待添加注释符号行均添加注释符号。

5.如权利要求4所述的方法，其特征在于，所述第一预设条件为所述待添加注释符号行为函数行，且所述待添加注释符号行、以及与所述待添加注释符号行连续的上一行均没有注释符号。

6.一种注释符号添加装置，其特征在于，所述装置包括：

请求接收模块，用于接收注释符号添加请求；

第一文件获取模块，用于依据所述注释符号添加请求，获取待添加注释符号的第一文件；

注释符号添加模块，用于调用预先建立的添加注释符号函数，为所述第一文件添加注释符号。

7.如权利要求6所述的装置，其特征在于，所述注释符号添加请求包括存储路径，当存储地址为文件路径时，所述第一文件获取模块具体用于：

依据所述存储地址，获取所述文件路径对应的文件，并将所述文件作为待添加注释符号的第一文件。

8.如权利要求6所述的装置，其特征在于，所述注释符号添加请求包括存储路径，当存储地址为文件夹路径时，所述第一文件获取模块具体用于：

依据所述存储地址，获取所述文件夹路径对应的文件夹；

遍历所述文件夹，获取所述文件夹下的所有文件，并将所述文件夹下的所有文件均作为待添加注释符号的第一文件。

9.如权利要求6所述的装置，其特征在于，所述注释符号添加模块具体用于：

依据第一预设条件，定位所述第一文件中的待添加注释符号行；

获取所述待添加注释符号行中的第一字符串；

利用第二字符串替换所述第一字符串，以将注释符号添加到所述待添加注释符号行中，其中，所述第二字符串包括注释符号和第一字符串；

遍历所述第一文件，为所述第一文件中的所有待添加注释符号行均添加注释符号。

10.一种电子设备，其特征在于，所述电子设备包括：

存储器；

处理器；以及

注释符号添加装置，所述注释符号添加装置存储于所述存储器中并包括一个或多个由所述处理器执行的软件功能模组，其包括：

请求接收模块，用于接收注释符号添加请求；

第一文件获取模块，用于依据所述注释符号添加请求，获取待添加注释符号的第一文件；

注释符号添加模块，用于调用预先建立的添加注释符号函数，为所述第一文件添加注释符号。