CN105824794A - 一种注释添加方法及装置 - Google Patents

Abstract

本发明公开了一种注释添加方法及装置，用以节省编程人员的时间。所述方法包括：在代码编辑过程中，当检测到有预设字符输入时，获取所述预设字符对应的目标代码；获取所述目标代码对应的注释；在所述目标代码之后添加所述目标代码对应的注释。采用本发明所提供的方法，当有预设字符输入时，获取该预设字符对应的目标代码，并获取该目标代码的注释，将该目标代码对应的注释添加在该目标代码之后，从而实现了代码注释的自动添加，无需进行人工添加，节省了编程人员的时间。

Description

一种注释添加方法及装置

技术领域

本发明涉及互联网技术领域，特别涉及一种注释添加方法及装置。

背景技术

代码是一种由字符、符号或信号码元以离散形式表示信息的明确的规则体系，其最终目的是将人类可读文本翻译成为计算机可执行的二进制指令，这种过程叫编译，通过编译器完成。

在代码编辑过程中，编程人员为了便于让自己和他人容易看懂该代码，通常会在代码后面添加注释，注释是指对代码的解释和说明，现有的代码注释方法中，注释的添加都是通过编程人员进行手动添加的，在添加注释过程中，为避免代码的编译错误，需要对注释添加特定的注释符号，从而避免注释被编译器误认为是代码而产生编译错误，可见对代码的注释是一项非常繁琐的工作，浪费了编程人员大量的时间，因而，如何提出一种注释添加方法来节省编程人员的时间，是一亟待解决的技术问题。

发明内容

本发明提供一种注释添加方法及装置，用以节省编程人员的时间。

本发明提供一种注释添加方法，包括：

在代码编辑过程中，当检测到有预设字符输入时，获取所述预设字符对应的目标代码；

获取所述目标代码对应的注释；

在所述目标代码之后添加所述目标代码对应的注释。

本发明的有益效果在于：当有预设字符输入时，获取该预设字符对应的目标代码，并获取该目标代码的注释，将该目标代码对应的注释添加在该目标代码之后，从而实现了代码注释的自动添加，无需进行人工添加，节省了编程人员的时间。

在一个实施例中，所述获取所述目标代码对应的注释，包括：

从自定义注释模板中获取所述目标代码对应的第一注释；或者

当不存在所述自定义注释模板时，从基础注释模板中获取所述目标代码对应的第二注释。

本实施例的有益效果在于：增加了目标代码的自定义注释模板，从而，能够丰富注释的内容，弥补基础注释模板中注释类型单一的缺陷，优化了自动添加注释的效果。

在一个实施例中，在从自定义注释模板中获取所述目标代码对应的第一注释之前，所述方法还包括：

当接收到对所述第二注释的编辑指令时，根据所述编辑指令对所述第二注释进行编辑以生成所述第一注释；

根据所述第一注释及所述目标代码生成自定义注释模板。

本实施例的有益效果在于：当接收到对来自基础注释模板中的注释的编辑指令时，根据该编辑指令对该注释进行编辑，并根据编辑后的注释生成自定义注释模板，通过增加自定义注释模板，从而使注释内容更加符合发出该编辑指令的用户的需求。

在一个实施例中，在从基础注释模板中获取所述目标代码对应的第二注释之前，所述方法还包括：

获取所述代码编辑过程中所使用的编程语言；

获取所述编程语言所对应的基础代码；

为所述基础代码添加所述基础代码对应的第二注释；

根据所述基础代码和所述第二注释生成基础注释模板。

本实施例的有益效果在于：通过代码编辑时使用的编程语言获取该编程语言所对应的基础代码，为该基础代码添加注释并根据该基础代码与对应注释生成基础注释模板，从而能够自动生成基础注释模板，无需人工制作，节省了人力成本。

在一个实施例中，所述方法还包括：

当检测到预设位置上的中文字符输入操作时，检测所述基础注释模板和所述自定义注释模板中是否存在与所述中文字符内容相同的注释；

当存在与所述中文字符内容相同的注释时，显示与所述中文字符相同的注释对应的代码。

本实施例的有益效果在于：当检测到在预设位置上检测中文字符的输入操作时，检测基础注释模板和自定义注释模板是否存在于该中文字符内容相同的注释，当存在时显示与中文字符相同的注释对应的代码，从而，实现了自动将中文字符翻译成代码的功能，避免编程人员遗忘代码时造成的编辑障碍。

本发明还提供一种注释添加装置，包括：

第一获取模块，用于在代码编辑过程中，当检测到有预设字符输入时，获取所述预设字符对应的目标代码；

第二获取模块，用于获取所述目标代码对应的注释；

添加模块，用于在所述目标代码之后添加所述目标代码对应的注释。

在一个实施例中，所述第二获取模块，包括：

第一获取子模块，用于从自定义注释模板中获取所述目标代码对应的第一注释；或者

第二获取子模块，用于当不存在所述自定义注释模板时，从基础注释模板中获取所述目标代码对应的第二注释。

在一个实施例中，所述装置还包括：

编辑模块，用于当接收到对所述第二注释的编辑指令时，根据所述编辑指令对所述第二注释进行编辑以生成所述第一注释；

第一生成模块，用于根据所述第一注释及所述目标代码生成自定义注释模板。

在一个实施例中，所述装置还包括：

第三获取模块，用于获取所述代码编辑过程中所使用的编程语言；

第四获取模块，用于获取所述编程语言所对应的基础代码；

添加模块，用于为所述基础代码添加所述基础代码对应的第二注释；

第二生成模块，用于根据所述基础代码和所述第二注释生成基础注释模板。

在一个实施例中，所述装置还包括：

检测模块，用于当检测到预设位置上的中文字符输入操作时，检测所述基础注释模板和所述自定义注释模板中是否存在与所述中文字符内容相同的注释；

显示模块，用于当存在与所述中文字符内容相同的注释时，显示与所述中文字符相同的注释对应的代码。

本发明的其它特征和优点将在随后的说明书中阐述，并且，部分地从说明书中变得显而易见，或者通过实施本发明而了解。本发明的目的和其他优点可通过在所写的说明书、权利要求书、以及附图中所特别指出的结构来实现和获得。

下面通过附图和实施例，对本发明的技术方案做进一步的详细描述。

附图说明

附图用来提供对本发明的进一步理解，并且构成说明书的一部分，与本发明的实施例一起用于解释本发明，并不构成对本发明的限制。在附图中：

图1为本发明一实施例中一种注释添加方法的流程图；

图2为本发明一实施例中一种注释添加方法的流程图；

图3为本发明一实施例中一种注释添加方法的流程图；

图4为本发明一实施例中一种注释添加装置的框图；

图5为本发明一实施例中一种注释添加装置的框图；

图6为本发明一实施例中一种注释添加装置的框图。

具体实施方式

以下结合附图对本发明的优选实施例进行说明，应当理解，此处所描述的优选实施例仅用于说明和解释本发明，并不用于限定本发明。

图1为本发明一实施例中一种注释添加方法的流程图，如图1所示，本发明中注释添加方法可用于终端，该方法可被实施为如下步骤S11-S13：

在步骤S11中，在代码编辑过程中，当检测到有预设字符输入时，获取预设字符对应的目标代码；

在步骤S12中，获取目标代码对应的注释；

在步骤S13中，在目标代码之后添加目标代码对应的注释。

在编程过程中，编程人员通常会对自己写的代码进行注释以解释和说明代码的含义或功能，这样的过程被称之为代码注释，代码注释能够便于其他人看懂自己写的代码。

本实施例中，公开一种自动添加代码注释的方法，由于代码通常是以行为单位进行注释或者以一个函数体为单位进行注释的，因而，在代码编辑过程中，可以通过监测用于换行的回车符或者监测用于表示一个函数体结束的花括号“{}”来判断一行代码或者一个函数体是否编写完成。

例如，编程人员通过面向对象的程序设计语言(Java语言)进行编程时，输入语句“g.drawRect(30,60,100,80)；”，在输入回车执行换行时，终端监测到该回车符，获取上述代码，并从注释模板中获取该行代码对应的注释为“绘制一个矩形”，将获得的注释添加到该行代码后面，形成带注释的代码如下：

g.drawRect(30,60,100,80)；//绘制一个矩形

其中，“//”为单行注释符号，该单行注释符号后面的内容是从注释模板中获取的注释信息。

在添加完注释之后，执行该回车符对应的换行指令。

或者，在一个函数体编辑完毕时，查询整个函数体对应的注释，将注释内容添加到该函数体之后，如在监测到花括号的后半个字符“}”输入时，确定一个函数体编辑完毕，通过注释模板获取花括号内每一行代码对应的注释，或者通过查询注释模板获取对该函数体整体的功能性注释，将获取到的每一行代码对应的注释添加到对应的代码之后，或将获取到的每一个函数体整体的功能性注释添加到该函数体之后，例如：编程人员输入一段代码如下：

在监测到第一个“}”输入时，由于前面有两个“{”，因而可确定函数体还未编辑完成，当检测到第二个“}”输入时，确定函数体编辑完成，此时，通过查询注释模板获取到上述函数体的功能为“显示括号内的信息”，将获取到的注释添加到该段代码第二个“}”之后，形成带注释的代码如下：

其中，“/**/”为多行注释符号，在多行注释符号中为从注释模板中获取到的内容。

由于本方案中是对代码进行自动注释，为了便于系统确定注释位置，以上示例均为将注释置于对应代码后面的情况，在实际应用当中，还可以根据需要或用户喜好将注释位置调整为置于相应代码的前面。

本发明的有益效果在于：当有预设字符输入时，获取该预设字符对应的目标代码，并获取该目标代码的注释，将该目标代码对应的注释添加在该目标代码之后，从而实现了代码注释的自动添加，无需进行人工添加，节省了编程人员的时间。

在一个实施例中，上述步骤S12可被实施为如下步骤A1或A2：

在步骤A1中：从自定义注释模板中获取目标代码对应的第一注释；或者

在步骤A2中，当不存在自定义注释模板时，从基础注释模板中获取目标代码对应的第二注释。

举例而言，在本方案中，包括自动生成的基础注释模板，还包括自定义注释模板，该自定义注释模板用于保存编程人员编程过程中对自动添加的注释进行修改后的自定义注释。

由于基础注释模板只能对基础代码进行注释，而编程人员自己定义的函数，变量名称，只有编程人员本人才知道具体含义，这样的情况下，根据基础注释模板自动添加的注释可能不能很好的对代码进行解释说明，因而，编程人员可能会在基础注释的基础上进行编辑。

当接收到编程人员对注释的编辑指令时，判断本次编辑是否是对添加的基础注释的首次编辑，当本次编辑是对添加的基础注释的首次编辑时，生成用于保存编辑后注释的自定义注释模板，将编辑后的注释添加到该自定义注释模板中，当本次编辑不是对添加的基础注释的首次编辑时，将编程人员进行编辑后的注释添加到已经生成的用于保存编辑后注释的自定义注释模板中。

本实施例中，在代码编辑过程中，当出现回车符时，首先从自定义注释模板中获取该回车符所在行中的代码对应的注释，当不存在自定义注释模板时，从基础注释模板中获取该回车符所在行中的代码对应的注释。

该自定义模板可仅用于本次开发过程中，也可将其保存以便应用于以后的开发过程中。

本实施例的有益效果在于：增加了目标代码的自定义注释模板，从而，能够丰富注释的内容，弥补基础注释模板中注释类型单一的缺陷，优化了自动添加注释的效果。

在一个实施例中，如图2所示，在上述步骤A1之前，该方法还可被实施为如下步骤S21-S22：

在步骤S21中，当接收到对第二注释的编辑指令时，根据编辑指令对第二注释进行编辑以生成第一注释；

在步骤S22中，根据第一注释及目标代码生成自定义注释模板。

本实施例中，由于基础注释模板只能对基础代码进行注释，有时候基础注释模板中的注释并不能很全面地解释代码含义，此时，编程人员可对根据基础注释模板添加的注释进行编辑。

仍以代码“g.drawRect(30,60,100,80)”为例，基础模板中的注释为“绘制一个矩形”，而这样的注释，并没有体现出括号中所提到的矩形的位置和尺寸大小，因而，这样的注释并不全面，在添加该注释后，编程人员可能会在该注释的基础上进行编辑，当接收编程人员对该注释的编辑指令时，根据该编辑指令对根据基础注释模板添加的注释进行编辑，形成根据该编辑指令进行编辑后的注释，例如，将原注释“绘制一个矩形”修改为“绘制一个横坐标为30，纵坐标为60，长为100，宽为80的矩形”，修改结果如下：

g.drawRect(30,60,100,80)；//绘制一个横坐标为30，纵坐标为60，长为100，宽为80的矩形

当上述修改是对添加的基础注释的首次编辑时，根据编辑后的注释生成自定义注释模板，并将该编辑后的注释添加到该自定义注释模板中，当本次编辑不是对添加的基础注释的首次编辑时，将编程人员进行编辑后的注释添加到已经生成的用于保存编辑后注释的自定义注释模板中。

本实施例的有益效果在于：当接收到对来自基础注释模板中的注释的编辑指令时，根据该编辑指令对该注释进行编辑，并根据编辑后的注释生成自定义注释模板，通过增加自定义注释模板，从而使注释内容更加符合发出该编辑指令的用户的需求。

在一个实施例中，如图3所示，在上述步骤A2之前，方法还可被实施为如下步骤S31-S24：

在步骤S31中，获取代码编辑过程中所使用的编程语言；

在步骤S32中，获取编程语言所对应的基础代码；

在步骤S33中，为基础代码添加基础代码对应的第二注释；

在步骤S34中，根据基础代码和第二注释生成基础注释模板。

本实施例介绍基础注释模板的生成过程，进行编程之前，当编程人员打开相应的编程平台时，根据该编程平台获取将要进行的代码编辑过程所使用的编程语言类型，在获取编程语言类型后，可根据下述几种方式获取该编程语言的基本注释：

首先，可获取该编程语言所对应的基础代码所对应的注释，例如，编程语言为面向对象程序设计语言时，可获取该面向对象程序设计语言的基础类库，通过各类渠道收集该基础类库中基础类的注释，如从网络中抓取各个基础类的注释，将抓取到的各个基础类的注释添加到基础注释模板中；

其次，还可以从与该编程语言对应的程序源代码中抽取类、方法、成员等的注释，将抽取到的类、方法、成员等的注释添加到基础注释模板中；

同时，还可以记录以前的开发过程中的常用代码及该常用代码的人工注释，将该常用代码及其人工注释的对应关系添加到基础注释模板中，并根据该基础类库中的代码和相应注释生成基础注释模板。

本方案中，基础注释模板中注释的获取渠道包括但不仅限于以上列举的几种示例。

本实施例的有益效果在于：通过代码编辑时使用的编程语言获取该编程语言所对应的基础代码，为该基础代码添加注释并根据该基础代码与对应注释生成基础注释模板，从而能够自动生成基础注释模板，无需人工制作，节省了人力成本。

在一个实施例中，在上述步骤S24或者上述步骤B2之后，方法还可被实施为如下步骤C1-C2：

在步骤C1中，当检测到预设位置上的中文字符输入操作时，检测基础注释模板和自定义注释模板中是否存在与中文字符内容相同的注释；

在步骤C2中，当存在与中文字符内容相同的注释时，显示与中文字符相同的注释对应的代码。

本实施例中，可预设一中文输入区域，监测该中文输入区域，当该中文输入区域有中文字符输入时，检测基础注释模板和自定义注释模板中是否存在与输入的中文字符内容相同的注释，当存在与该中文字符内容相同的注释时，显示与该中文字符相同的注释对应的代码，与该中文字符相同的注释对应的代码可显示于该中文字符之后。当编辑人员忘记代码语句时，或者当代码语句过长时，可通过在预设区域输入相应的中文注释使该代码显示，从而避免编程语言遗忘代码时造成的编辑障碍，或避免代码过长导致的时间上的浪费。

本实施例的有益效果在于：当检测到在预设位置上检测中文字符的输入操作时，检测基础注释模板和自定义注释模板是否存在与该中文字符内容相同的注释，当存在时显示与中文字符相同的注释对应的代码，从而，实现了自动将中文字符翻译成代码的功能，避免编程人员遗忘代码时造成的编辑障碍。

图4为本发明一实施例中一种注释添加装置的框图，如图1所示，本发明中注释添加装置可用于终端，该装置包括如下模块：

第一获取模块41，用于在代码编辑过程中，当检测到有预设字符输入时，获取预设字符对应的目标代码；

第二获取模块42，用于获取目标代码对应的注释；

添加模块43，用于在目标代码之后添加目标代码对应的注释。

在一个实施例中，第二获取模块，包括：

第一获取子模块，用于从自定义注释模板中获取目标代码对应的第一注释；或者

第二获取子模块，用于当不存在自定义注释模板时，从基础注释模板中获取目标代码对应的第二注释。

在一个实施例中，如图5所示，装置还包括：

编辑模块51，用于当接收到对第二注释的编辑指令时，根据编辑指令对第二注释进行编辑以生成第一注释；

第一生成模块52，用于根据第一注释及目标代码生成自定义注释模板。

在一个实施例中，如图6所示，装置还包括：

第三获取模块61，用于获取代码编辑过程中所使用的编程语言；

第四获取模块62，用于获取编程语言所对应的基础代码；

添加模块63，用于为基础代码添加基础代码对应的第二注释；

第二生成模块64，用于根据基础代码和第二注释生成基础注释模板。

在一个实施例中，装置还包括：

检测模块，用于当检测到预设位置上的中文字符输入操作时，检测基础注释模板和自定义注释模板中是否存在与中文字符内容相同的注释；

显示模块，用于当存在与中文字符内容相同的注释时，显示与中文字符相同的注释对应的代码。

本领域内的技术人员应明白，本发明的实施例可提供为方法、系统、或计算机程序产品。因此，本发明可采用完全硬件实施例、完全软件实施例、或结合软件和硬件方面的实施例的形式。而且，本发明可采用在一个或多个其中包含有计算机可用程序代码的计算机可用存储介质(包括但不限于磁盘存储器和光学存储器等)上实施的计算机程序产品的形式。

本发明是参照根据本发明实施例的方法、设备(系统)、和计算机程序产品的流程图和/或方框图来描述的。应理解可由计算机程序指令实现流程图和/或方框图中的每一流程和/或方框、以及流程图和/或方框图中的流程和/或方框的结合。可提供这些计算机程序指令到通用计算机、专用计算机、嵌入式处理机或其他可编程数据处理设备的处理器以产生一个机器，使得通过计算机或其他可编程数据处理设备的处理器执行的指令产生用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的装置。

这些计算机程序指令也可存储在能引导计算机或其他可编程数据处理设备以特定方式工作的计算机可读存储器中，使得存储在该计算机可读存储器中的指令产生包括指令装置的制造品，该指令装置实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能。

这些计算机程序指令也可装载到计算机或其他可编程数据处理设备上，使得在计算机或其他可编程设备上执行一系列操作步骤以产生计算机实现的处理，从而在计算机或其他可编程设备上执行的指令提供用于实现在流程图一个流程或多个流程和/或方框图一个方框或多个方框中指定的功能的步骤。

显然，本领域的技术人员可以对本发明进行各种改动和变型而不脱离本发明的精神和范围。这样，倘若本发明的这些修改和变型属于本发明权利要求及其等同技术的范围之内，则本发明也意图包含这些改动和变型在内。

Claims (10)

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

在代码编辑过程中，当检测到有预设字符输入时，获取所述预设字符对应的目标代码；

获取所述目标代码对应的注释；

在所述目标代码之后添加所述目标代码对应的注释。

2.如权利要求1所述的方法，其特征在于，所述获取所述目标代码对应的注释，包括：

从自定义注释模板中获取所述目标代码对应的第一注释；或者

当不存在所述自定义注释模板时，从基础注释模板中获取所述目标代码对应的第二注释。

3.如权利要求2所述的方法，其特征在于，在从自定义注释模板中获取所述目标代码对应的第一注释之前，所述方法还包括：

当接收到对所述第二注释的编辑指令时，根据所述编辑指令对所述第二注释进行编辑以生成所述第一注释；

根据所述第一注释及所述目标代码生成自定义注释模板。

4.如权利要求2所述的方法，其特征在于，在从基础注释模板中获取所述目标代码对应的第二注释之前，所述方法还包括：

获取所述代码编辑过程中所使用的编程语言；

获取所述编程语言所对应的基础代码；

为所述基础代码添加所述基础代码对应的第二注释；

根据所述基础代码和所述第二注释生成基础注释模板。

5.如权利要求2-4中任意一项所述的方法，其特征在于，所述方法还包括：

当检测到预设位置上的中文字符输入操作时，检测所述基础注释模板和所述自定义注释模板中是否存在与所述中文字符内容相同的注释；

当存在与所述中文字符内容相同的注释时，显示与所述中文字符相同的注释对应的代码。

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

第一获取模块，用于在代码编辑过程中，当检测到有预设字符输入时，获取所述预设字符对应的目标代码；

第二获取模块，用于获取所述目标代码对应的注释；

添加模块，用于在所述目标代码之后添加所述目标代码对应的注释。

7.如权利要求6所述的装置，其特征在于，所述第二获取模块，包括：

第一获取子模块，用于从自定义注释模板中获取所述目标代码对应的第一注释；或者

第二获取子模块，用于当不存在所述自定义注释模板时，从基础注释模板中获取所述目标代码对应的第二注释。

8.如权利要求7所述的装置，其特征在于，所述装置还包括：

编辑模块，用于当接收到对所述第二注释的编辑指令时，根据所述编辑指令对所述第二注释进行编辑以生成所述第一注释；

第一生成模块，用于根据所述第一注释及所述目标代码生成自定义注释模板。

9.如权利要求7所述的装置，其特征在于，所述装置还包括：

第三获取模块，用于获取所述代码编辑过程中所使用的编程语言；

第四获取模块，用于获取所述编程语言所对应的基础代码；

添加模块，用于为所述基础代码添加所述基础代码对应的第二注释；

第二生成模块，用于根据所述基础代码和所述第二注释生成基础注释模板。

10.如权利要求7-9中任意一项所述的装置，其特征在于，所述装置还包括：

检测模块，用于当检测到预设位置上的中文字符输入操作时，检测所述基础注释模板和所述自定义注释模板中是否存在与所述中文字符内容相同的注释；

显示模块，用于当存在与所述中文字符内容相同的注释时，显示与所述中文字符相同的注释对应的代码。