CN102129365A - 一种生成代码说明文档的方法及装置 - Google Patents
一种生成代码说明文档的方法及装置 Download PDFInfo
- Publication number
- CN102129365A CN102129365A CN2010100042843A CN201010004284A CN102129365A CN 102129365 A CN102129365 A CN 102129365A CN 2010100042843 A CN2010100042843 A CN 2010100042843A CN 201010004284 A CN201010004284 A CN 201010004284A CN 102129365 A CN102129365 A CN 102129365A
- Authority
- CN
- China
- Prior art keywords
- code
- class
- target class
- notes content
- label
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
Images
Landscapes
- Information Retrieval, Db Structures And Fs Structures Therefor (AREA)
Abstract
本申请实施例公开了一种生成代码说明文档的方法及装置。所述方法包括：接收生成代码说明文档的指令，所述生成代码说明文档的指令中包含类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容；根据所述类标识从指定的源代码中查询到目标类，并在所述目标类中依据所述方法标识查找到目标方法；在所述目标方法的注释中依据所述标签过滤查找到所需的注释内容，以保留符合不同受众类型要求的注释；将过滤后的注释内容生成符合不同受众类型要求的代码说明文档。本申请实施例可以根据不同的受众分别生成不同的代码说明文档。
Description
技术领域
本申请涉及计算机技术领域，尤其涉及一种生成代码说明文档的方法及装置。
背景技术
Javadoc可以从源代码中抽取类、方法、成员等注释形成一个和源代码配套的应用程序编程接口(API，Application Programming Interface)代码说明文档。也就是说，程序员在编写源代码时以特定的标签作注释，在源代码编写完成后，通过Javadoc就可以得到代码说明文档。代码说明文档可以使受众快速了解源代码的含义。
但在具体的大型项目开发中，参与开发的人员极多，例如，在一个软件公司内部，一个大型项目的开发涉及到跨部门之间的合作，甚至有些部分需要委托公司外部的人员完成。该项目的开发主导者并不希望所有参与开发的人员都得到一样的代码说明文档，比如：对于本公司外部的人员，开发主导者并不希望他们了解到一些源代码的重要信息，而对于公司内部的测试人员，则需要让他们了解更多的内容以编写测试用例。但现有的Javadoc技术仅能提供一种代码说明文档。
发明内容
本申请实施例的目的是提供一种生成代码说明文档的方法及装置，可以根据不同的受众分别生成不同的代码说明文档。
一种生成代码说明文档的方法，所述方法包括：
接收生成代码说明文档的指令，所述生成代码说明文档的指令中包含类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容；
根据所述类标识从指定的源代码中查询到目标类，并在所述目标类中依据所述方法标识查找到目标方法；
在所述目标方法的注释中依据所述标签过滤查找到所需的注释内容，以保留符合不同受众类型要求的注释；
将过滤后的注释内容生成符合不同受众类型要求的代码说明文档。
优选的，在所述目标方法的注释中依据所述标签过滤查找到的方法注释之后，所述方法还包括：
输出在所述目标方法的注释中过滤查找到的所需的注释内容。
优选的，在所述将过滤后的注释内容生成符合不同受众类型要求的代码说明文档之前，所述方法还包括：
当所述目标类为多个时，分别对所述源代码中的其它目标类执行与所述目标类相同的操作；
则所述将查找过滤的注释内容生成符合不同受众类型要求的代码说明文档包括：
针对所述源代码中的各个目标类，将过滤后的注释内容生成代码说明文档。
优选的，在所述将查找过滤后的注释内容生成代码说明文档之后，所述方法还包括：
将生成的所述代码说明文档按照不同的受众类型展现给用户。
一种生成代码说明文档的装置，所述装置包括：
接收单元，用于接收生成代码说明文档的指令，所述生成代码说明文档的指令中包含类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容；
检索单元，用于根据所述类标识从指定的源代码中查询到目标类；
查找单元，用于在所述检索单元检索出的目标类中依据所述方法标识查找到目标方法；
过滤单元，用于根据在所述目标方法的注释中依据所述标签过滤查找到所需的注释内容，以保留符合不同受众类型要求的注释；
生成单元，用于将过滤后的注释内容生成符合不同受众类型要求的代码说明文档。
优选的，所述装置还包括：
输出单元，用于在所述过滤单元执行操作之后，输出在所述目标方法的注释中过滤查找到的所需的注释内容。
优选的，所述装置还包括：
继续执行单元，用于在所述生成单元执行操作之前，当所述目标类为多个时，分别对所述源代码中的其它目标类执行与所述目标类相同的操作；
所述生成单元用于还针对所述源代码中的各个目标类，将过滤后的注释内容生成代码说明文档。
优选的，所述装置还包括：
展现单元，用于在所述生成单元执行操作之后，将所述生成单元生成的代码说明文档按照不同的受众类型展现给用户。
可以看出，在本申请实施例中，接收到的生成代码说明文档的指令中包含：类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容，检索出源代码的一个目标类后，在检索出的一个目标类中再依据方法标识查找相应的目标方法，根据标签在一个目标方法中过滤查找到的注释内容，最后针对源代码的各个类，将过滤后的注释内容生成代码说明文档，从而可以根据不同的受众分别生成不同的代码说明文档。另外，本申请根据生成代码说明文档的指令能够自动、有选择的到源代码中进行检索并提取相应的代码注释内容，提高了生成代码说明文档的速度，能够灵活的配置代码说明文档的内容。
附图说明
为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请中记载的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。
图1为本申请实施例一种生成代码说明文档的方法流程图；
图2为本申请实施例另一种生成代码说明文档的方法流程图；
图3为本申请实施例提供的一种生成代码说明文档的装置结构示意图；
图4为本申请实施例提供的另一种生成代码说明文档的装置结构示意图。
具体实施方式
为了使本技术领域的人员更好地理解本申请中的技术方案，下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都应当属于本申请保护的范围。
请参考图1，为本申请实施例一种生成代码说明文档的方法流程图，可以包括以下步骤：
步骤101：接收生成代码说明文档的指令，所述生成代码说明文档的指令中包含：类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容。
所述生成代码说明文档的指令中包括的类标识用于唯一表示一个类，例如，@gendoc；计算机后续可以根据预置的类标识，从指定的源代码中查找到相应的目标类。所述方法标识用于唯一表示类中的一个代码模块。所述标签可以表示生成代码说明文档中需要的内容，例如，当标签为“sql”时，表示生成的代码说明文档中需要包括一段结构化查询语言(Structured QueryLanguage，SQL)，该标签所表示出的内容可以从对方法所做的注释中查找得到。
当标签不同时，说明生成代码说明文档的内容也不同，因为不同的生成代码说明文档对应可以看到该文档的不同的受众类型，因此对于某个标签或者某些标签来讲，也可以代表着不同受众类型。其中，受众是可以获取到代码说明文档的人员，根据受众类型的不同需要生成不同类型的代码说明文档，受众类型例如：包括公司外部人员或者公司内部人员。但是，标签本身并不直接代表着公司外部或者内部人员。
步骤102：根据所述类标识从指定的源代码中查询到目标类，并在所述目标类中依据所述方法标识查找到目标方法。
步骤103：在所述目标方法的注释中依据所述标签过滤查找到所需的注释内容以保留符合不同受众类型要求的注释。
步骤104：将过滤后的注释内容生成符合不同受众类型要求的代码说明文档。
可以看出，在本申请实施例中，接收到的生成代码说明文档的指令中包含：类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容，检索出源代码的一个目标类后，在检索出的一个目标类中再依据方法标识查找相应的目标方法，根据标签在一个目标方法中过滤查找到的注释内容，最后针对源代码的各个类，将过滤后的注释内容生成代码说明文档，从而可以根据不同的受众分别生成不同的代码说明文档。
下面结合更加具体的实施例对本申请进行说明。在该实施例中，假设源代码有2个类。
请参考图2，为本申请实施例另一种生成代码说明文档的方法流程图，可以包括以下步骤：
步骤201：计算机接收生成代码说明文档的指令，生成代码说明文档的指令中包括类标识、方法标识和标签。
步骤202：计算机对指定的源代码进行检索，根据第一个类标识检索出所述源代码中的第一个目标类。
源代码中包含的类的个数可以任意，在本实施例中，假设源代码仅有2个类，则计算机首先对第一个目标类进行查找。其中，所述指定的源代码即是需要生成对应的代码说明文档的源代码，所述检索到的目标类即是需要进行分析的类。
步骤203：计算机在检索出的第一个目标类中依据方法标识查找到第一目标方法。
在本实施例中的一个类中包括了多个代码模块，其中每个代码模块可以称为一个方法，每个方法都可以是独立的，可以采用方法标识来区别，例如，@docmethod。因此，在本步骤中，即是在步骤201中检索到的目标类中依据方法标识查询对应的方法，即是在第一个目标类中查找到包括@docmethod的一个代码模块。
步骤204：计算机根据所述标签在所述第一目标方法中过滤查找到所需要的注释内容。
例如，假设计算机接收到的指令为：output＝user_case，sql，demo，其中，用例(user_case)、结构化查询语言(sql)以及例子(demo)均为标签，指令“output＝user_case，sql，demo”中的“user_case，sql，demo”为标签组合，即是根据该标签组合查找到的注释，可以后续生成某种受众类型能看到的代码说明文档所需要的内容。计算机从目标方法的注释中抽取包括了所述标签的注释内容。该目标方法的注释就已经含于指定的源代码中，即是源代码在编写完成之后，就包括了注释。在本步骤中过滤查找的含义表示，计算机根据标签保留符合受众类型要求的注释，滤除不符合受众类型要求的注释。
步骤205：计算机输出在第一个目标类中过滤后的注释内容。
在本步骤中，计算机将步骤204中过滤查找到的注释内容进行输出，需要说明的是，计算机也可以在步骤204之后直接进入步骤206，即是直接继续查找第二个目标类中所需要的注释内容，等到第二个目标类中所需要的注释内容也查找完毕之后，再一并进行输出。本申请对于步骤205的顺序并不做限定。
步骤206：计算机继续对源代码进行检索，根据第二个类标识检索出所述源代码中的第二个目标类。
其中，计算机根据类标识检索得到目标类的方式在步骤202中已经进行了介绍，在此不再赘述。需要说明的是，在本申请实施例中，对两个目标类分别进行处理，即是对第一个目标类中的注释内容查询完毕之后，才开始对第二个目标类进行类似处理，但是本领域技术人员也可以知道，在实际应用中，对这两个目标类中注释内容的查询过程也可以同步进行。本申请实施例无需限定其先后顺序。当指定的源代码中存在多个类时，也可以对该多个类同步进行注释内容的查找过程，或者分别进行各个类中注释内容的查找过程。
步骤207：计算机在检索出的第二个目标类中依据方法标识查找到第二目标方法。
步骤208：计算机根据所述标签在所述第二目标方法中过滤查找到所需要的注释内容。
步骤209：计算机输出在第二个目标类中过滤后的注释内容。
需要说明的是，在本步骤中，所述计算机也可以不进行输出，而是直接将在第一个目标类和第二个目标类中过滤查找得到的注释内容直接组合，以生成代码说明文档。
步骤210：计算机将输出的第一个类中过滤得到的注释内容以及第二个类中过滤得到的注释内容生成代码说明文档。
步骤211：计算机将生成的代码说明文档按照不同的受众类型展现给用户。
具体地在实现过程中，计算机将输出结果按docbook语法生成到一个a.xml文件，然后通过docbook解析这个a.xml文件，从而产生用户可见的不同格式的代码说明文档，如pdf文档、word文档，或者html等。
在上述实施例中，假设源代码仅有2个类，当然源代码包含的类的个数不限于此。对于本申请来说，需要先检索出源代码的一个目标类，在本次检索出的目标类中查找目标方法，查找到的目标方法可以至少有一个，并逐个对查找到的目标方法的注释进行过滤，然后输出过滤后的注释内容，至此，完成了对源代码的一个目标类执行的操作。对源代码的一个类执行完操作后，再对源代码的其它各个目标类执行相同的操作，不同之处仅在于在检索目标类时使用的类标识不同，在查找目标类中的目标方法时使用的方法标识不同。
可以看出，在本申请实施例中，接收到的生成代码说明文档的指令中包含可以查找到代码说明文档所需内容的标签，检索出源代码的一个目标类后，在检索出的一个目标类中检索目标方法，并根据不同的标签在一个目标类中过滤查找到生成代码说明文档所需的注释内容，最后针对源代码的各个类，将过滤后的方法注释内容生成代码说明文档，从而可以分别生成针对不同的受众类型的代码说明文档。
下面以一个具体实例对本申请实施例生成的代码说明文档进行说明。
在具体实例中，根据一个类标识检索出了源代码的一个目标类，检索出的类的目标方法的注释如下：
/**
*按照“业务主体标识+产品组名称”查询当前月份的已用额度。
*
*<demo>
*创建按照“业务主体标识+产品组名称”查询当前月份的已用额度的请求。
*
*<pre>
*String keyBizNo＝″20880012453967850156″；//业务主体标识
*String productGroup＝″AP_TOTAL″；//产品组名称
*
*ProductAmountQueryResultresult＝this.prodtransQueryFacade
*.queryStatMonthCurrentAmount(keyBizNo，productGroup)；
*</pre>
*</demo>
*
*<sql>
*select count(amount)
*from month_table
*where month ＝？
*and keyBizNo ＝？
*and productGroup＝？
*</sql>
*
*@param keyBizNo 业务主体标识
*@param productGroup产品组名称
*@return金额不存在返回0，次数不存在返回0
*/
Money queryCurrentMonthAmount(String keyBizNo，String productGroup)；
则利用本申请实施例提供的方法，为不同的受众类型生成的代码说明文档不同。
(1)若受众类型为公司外部人员，则生成的代码说明文档为：
简要说明：
按照“业务主体标识+产品组名称”查询当前月份的已用额度。
类名：
ProdtransQueryFacade
方法名：
queryStatMonthCurrentAmount
接口参数：
| 参数 | 类型 | 取值范围 | 备注 |
| 业务主体标识 | String | 必要参数 | |
| 产品组名称 | String | 必要参数 |
DEMO：
创建按照“业务主体标识+产品组名称”查询当前月份的已用额度的请求。
String keyBizNo＝″20880012453967850156″；//业务主体标识
StringproductGroup＝″AP_TOTAL″；//产品组名称
ProductAmountQueryResult result＝this.prodtransQueryFacade
.queryStatMonthCurrentAmount(keyBizNo，productGroup)；
返回值：
Money
(2)若受众类型为公司内部人员，则生成的代码说明文档为：
简要说明：
按照“业务主体标识+产品组名称”查询当前月份的已用额度。
类名：
ProdtransQueryFacade
方法名：
queryStatMonthCurrentAmount
接口参数：
| 参数 | 类型 | 取值范围 | 备注 |
| 业务主体标识 | String | 必要参数 | |
| 产品组名称 | String | 必要参数 |
SQL：
select count(amount)
from month_table
where month ＝？
and keyBizNo ＝？
and productGroup＝？
返回值：
Money
从上面具体实例可以看出，对公司外部人员屏蔽了sql语句，展现了一个使用该方法的例子，对公司内部人员展现了sql语句，屏蔽了使用该方法的例子。
可以看出，在本申请实施例中，接收到的生成代码说明文档的指令中包含表示不同受众类型的标签，检索出源代码的一个类后，在检索出的一个类中查找含有特定标签的方法，根据表示不同受众类型的标签在一个类中过滤查找到的方法的注释，最后针对源代码的各个类，将过滤后的方法的注释生成代码说明文档，从而可以根据不同的受众分别生成不同的代码说明文档。另外，本申请根据生成代码说明文档的指令能够自动、有选择的到源代码中进行检索并提取相应的代码注释内容，提高了生成代码说明文档的速度，能够灵活的配置代码说明文档的内容。
请参考图3，为本申请实施例提供的一种生成代码说明文档的装置结构示意图，可以包括：
接收单元301，用于接收生成代码说明文档的指令，所述生成代码说明文档的指令中包含类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容。
检索单元302，用于根据所述类标识从指定的源代码中查询到目标类。
查找单元303，用于在所述检索单元302检索出的目标类中依据所述方法标识查找到目标方法。
过滤单元304，用于在所述目标方法的注释中依据所述标签过滤查找到所需的注释内容，以保留符合不同受众类型要求的注释。
生成单元305，用于将过滤后的注释内容生成符合不同受众类型要求的代码说明文档。
可以看出，在本申请实施例中，接收到的生成代码说明文档的指令中包含表示不同受众类型的标签，检索出源代码的一个类后，在检索出的一个类中查找含有特定标签的方法，根据表示不同受众类型的标签在一个类中过滤查找到的方法的注释，最后针对源代码的各个类，将过滤后的方法的注释生成代码说明文档，从而可以根据不同的受众分别生成不同的代码说明文档。
请参考图4，为本申请实施例提供的另一种生成代码说明文档的装置结构示意图，在图3的基础上，还可以包括：
输出单元401，用于在所述过滤单元304执行操作之后，输出在所述目标方法的注释中过滤查找到的所需的注释内容。
继续执行单元402，用于在所述生成单元305执行操作之前，当所述目标类为多个时，分别对所述源代码中的其它目标类执行与所述目标类相同的操作；
所述生成单元305用于还针对所述源代码中的各个目标类，将过滤后的方法的注释包含的内容生成代码说明文档。
展现单元403，用于在所述生成单元305执行操作之后，将所述生成单元305生成的代码说明文档按照不同的受众类型展现给用户。
为了描述的方便，描述以上装置时以功能分为各种单元分别描述。当然，在实施本申请时可以把各单元的功能在同一个或多个软件和/或硬件中实现。
可以看出，在本申请实施例中，接收到的生成代码说明文档的指令中包含表示不同受众类型的标签，检索出源代码的一个类后，在检索出的一个类中查找含有特定标签的方法，根据表示不同受众类型的标签在一个类中过滤查找到的方法的注释，最后针对源代码的各个类，将过滤后的方法的注释生成代码说明文档，从而可以根据不同的受众分别生成不同的代码说明文档。
通过以上的实施方式的描述可知，本领域的技术人员可以清楚地了解到本申请可借助软件加必需的通用硬件平台的方式来实现。基于这样的理解，本申请的技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品可以存储在存储介质中，如ROM/RAM、磁碟、光盘等，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本申请各个实施例或者实施例的某些部分所述的方法。
本说明书中的各个实施例均采用递进的方式描述，各个实施例之间相同相似的部分互相参见即可，每个实施例重点说明的都是与其他实施例的不同之处。尤其，对于系统实施例而言，由于其基本相似于方法实施例，所以描述的比较简单，相关之处参见方法实施例的部分说明即可。
本申请可用于众多通用或专用的计算系统环境或配置中。例如：个人计算机、服务器计算机、手持设备或便携式设备、平板型设备、多处理器系统、基于微处理器的系统、置顶盒、可编程的消费电子设备、网络PC、小型计算机、大型计算机、包括以上任何系统或设备的分布式计算环境等等。
本申请可以在由计算机执行的计算机可执行指令的一般上下文中描述，例如程序模块。一般地，程序模块包括执行特定任务或实现特定抽象数据类型的例程、程序、对象、组件、数据结构等等。也可以在分布式计算环境中实践本申请，在这些分布式计算环境中，由通过通信网络而被连接的远程处理设备来执行任务。在分布式计算环境中，程序模块可以位于包括存储设备在内的本地和远程计算机存储介质中。
虽然通过实施例描绘了本申请，本领域普通技术人员知道，本申请有许多变形和变化而不脱离本申请的精神，希望所附的权利要求包括这些变形和变化而不脱离本申请的精神。
Claims (8)
1.一种生成代码说明文档的方法，其特征在于，所述方法包括：
接收生成代码说明文档的指令，所述生成代码说明文档的指令中包含类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容；
根据所述类标识从指定的源代码中查询到目标类，并在所述目标类中依据所述方法标识查找到目标方法；
在所述目标方法的注释中依据所述标签过滤查找到所需的注释内容，以保留符合不同受众类型要求的注释；
将过滤后的注释内容生成符合不同受众类型要求的代码说明文档。
2.根据权利要求1所述的方法，其特征在于，在所述目标方法的注释中依据所述标签过滤查找到的方法注释之后，所述方法还包括：
输出在所述目标方法的注释中过滤查找到的所需的注释内容。
3.根据权利要求2所述的方法，其特征在于，在所述将过滤后的注释内容生成符合不同受众类型要求的代码说明文档之前，所述方法还包括：
当所述目标类为多个时，分别对所述源代码中的其它目标类执行与所述目标类相同的操作；
则所述将查找过滤的注释内容生成符合不同受众类型要求的代码说明文档包括：
针对所述源代码中的各个目标类，将过滤后的注释内容生成代码说明文档。
4.根据权利要求1所述的方法，其特征在于，在所述将查找过滤后的注释内容生成代码说明文档之后，所述方法还包括：
将生成的所述代码说明文档按照不同的受众类型展现给用户。
5.一种生成代码说明文档的装置，其特征在于，所述装置包括：
接收单元，用于接收生成代码说明文档的指令，所述生成代码说明文档的指令中包含类标识、方法标识和标签，所述标签用于标识出生成不同受众类型的代码说明文档所需的注释内容；
检索单元，用于根据所述类标识从指定的源代码中查询到目标类；
查找单元，用于在所述检索单元检索出的目标类中依据所述方法标识查找到目标方法；
过滤单元，用于根据在所述目标方法的注释中依据所述标签过滤查找到所需的注释内容，以保留符合不同受众类型要求的注释；
生成单元，用于将过滤后的注释内容生成符合不同受众类型要求的代码说明文档。
6.根据权利要求5所述的装置，其特征在于，所述装置还包括：
输出单元，用于在所述过滤单元执行操作之后，输出在所述目标方法的注释中过滤查找到的所需的注释内容。
7.根据权利要求6所述的装置，其特征在于，所述装置还包括：
继续执行单元，用于在所述生成单元执行操作之前，当所述目标类为多个时，分别对所述源代码中的其它目标类执行与所述目标类相同的操作；
所述生成单元用于还针对所述源代码中的各个目标类，将过滤后的注释内容生成代码说明文档。
8.根据权利要求5所述的装置，其特征在于，所述装置还包括：
展现单元，用于在所述生成单元执行操作之后，将所述生成单元生成的代码说明文档按照不同的受众类型展现给用户。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN2010100042843A CN102129365A (zh) | 2010-01-20 | 2010-01-20 | 一种生成代码说明文档的方法及装置 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN2010100042843A CN102129365A (zh) | 2010-01-20 | 2010-01-20 | 一种生成代码说明文档的方法及装置 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN102129365A true CN102129365A (zh) | 2011-07-20 |
Family
ID=44267456
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN2010100042843A Pending CN102129365A (zh) | 2010-01-20 | 2010-01-20 | 一种生成代码说明文档的方法及装置 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN102129365A (zh) |
Cited By (19)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN102567016A (zh) * | 2011-12-07 | 2012-07-11 | 北京北大软件工程发展有限公司 | 应用程序编程接口使用示例提取方法及装置 |
| CN103309879A (zh) * | 2012-03-12 | 2013-09-18 | 汉王科技股份有限公司 | 一种管理word文档中的标记的方法及装置 |
| CN104035862A (zh) * | 2013-03-08 | 2014-09-10 | 腾讯科技（深圳）有限公司 | 闭包测试方法和装置 |
| CN104156198A (zh) * | 2013-05-14 | 2014-11-19 | 广东电网公司信息中心 | 一种自动生成软件集成版本更新说明方法及装置 |
| CN104156199A (zh) * | 2013-05-14 | 2014-11-19 | 广东电网公司信息中心 | 一种软件自动持续集成方法及系统 |
| CN105988801A (zh) * | 2015-02-13 | 2016-10-05 | 腾讯科技（深圳）有限公司 | 一种显示注释信息的方法及装置 |
| CN106339313A (zh) * | 2016-08-12 | 2017-01-18 | 南京航空航天大学 | 一种Java API程序异常与文档的描述不一致自动检测方法 |
| CN106681708A (zh) * | 2016-11-16 | 2017-05-17 | 中国科学院软件研究所 | 一种基于数据挖掘的源代码注释自动生成方法 |
| CN107203535A (zh) * | 2016-03-16 | 2017-09-26 | 阿里巴巴集团控股有限公司 | 信息查询方法及装置 |
| CN107885499A (zh) * | 2017-10-19 | 2018-04-06 | 平安壹钱包电子商务有限公司 | 一种接口文档生成方法及终端设备 |
| CN108021353A (zh) * | 2017-12-11 | 2018-05-11 | 中盈优创资讯科技有限公司 | 软件产品的说明文档的生成装置、方法、设备及存储介质 |
| CN108920181A (zh) * | 2018-06-29 | 2018-11-30 | 北京拜克洛克科技有限公司 | 文件处理方法、装置及电子设备 |
| CN109799990A (zh) * | 2017-11-16 | 2019-05-24 | 中标软件有限公司 | 源代码注释自动生成方法及系统 |
| CN109901934A (zh) * | 2017-12-11 | 2019-06-18 | 北京京东尚科信息技术有限公司 | 生成接口帮助文档的方法和装置 |
| WO2019169814A1 (zh) * | 2018-03-09 | 2019-09-12 | 平安科技（深圳）有限公司 | 自动生成中文注释的方法、装置、设备及存储介质 |
| CN110955416A (zh) * | 2019-10-12 | 2020-04-03 | 平安普惠企业管理有限公司 | 接口文档生成方法、装置、设备和计算机存储介质 |
| CN112836477A (zh) * | 2021-01-15 | 2021-05-25 | 亿企赢网络科技有限公司 | 代码注释文档的生成方法、装置、电子设备及存储介质 |
| CN113495753A (zh) * | 2021-07-06 | 2021-10-12 | 北京百度网讯科技有限公司 | 项目的标签获取方法、装置、电子设备及存储介质 |
| CN115599388A (zh) * | 2022-10-17 | 2023-01-13 | 中航信移动科技有限公司（Cn） | 一种api接口文档生成方法、存储介质及电子设备 |
Citations (2)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US6507855B1 (en) * | 1998-06-25 | 2003-01-14 | Cisco Technology, Inc. | Method and apparatus for extracting data from files |
| US20050060688A1 (en) * | 2003-09-17 | 2005-03-17 | Kamalakantha Chandra H. | Automated source code software programmer's manual generator |
-
2010
- 2010-01-20 CN CN2010100042843A patent/CN102129365A/zh active Pending
Patent Citations (2)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US6507855B1 (en) * | 1998-06-25 | 2003-01-14 | Cisco Technology, Inc. | Method and apparatus for extracting data from files |
| US20050060688A1 (en) * | 2003-09-17 | 2005-03-17 | Kamalakantha Chandra H. | Automated source code software programmer's manual generator |
Cited By (29)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN102567016B (zh) * | 2011-12-07 | 2015-06-03 | 北京北大软件工程发展有限公司 | 应用程序编程接口使用示例提取方法及装置 |
| CN102567016A (zh) * | 2011-12-07 | 2012-07-11 | 北京北大软件工程发展有限公司 | 应用程序编程接口使用示例提取方法及装置 |
| CN103309879A (zh) * | 2012-03-12 | 2013-09-18 | 汉王科技股份有限公司 | 一种管理word文档中的标记的方法及装置 |
| CN103309879B (zh) * | 2012-03-12 | 2017-03-22 | 汉王科技股份有限公司 | 一种管理word文档中的标记的方法及装置 |
| CN104035862A (zh) * | 2013-03-08 | 2014-09-10 | 腾讯科技（深圳）有限公司 | 闭包测试方法和装置 |
| CN104156198A (zh) * | 2013-05-14 | 2014-11-19 | 广东电网公司信息中心 | 一种自动生成软件集成版本更新说明方法及装置 |
| CN104156199A (zh) * | 2013-05-14 | 2014-11-19 | 广东电网公司信息中心 | 一种软件自动持续集成方法及系统 |
| CN104156199B (zh) * | 2013-05-14 | 2017-09-22 | 广东电网公司信息中心 | 一种软件自动持续集成方法及系统 |
| CN105988801A (zh) * | 2015-02-13 | 2016-10-05 | 腾讯科技（深圳）有限公司 | 一种显示注释信息的方法及装置 |
| CN105988801B (zh) * | 2015-02-13 | 2020-01-24 | 腾讯科技（深圳）有限公司 | 一种显示注释信息的方法及装置 |
| CN107203535A (zh) * | 2016-03-16 | 2017-09-26 | 阿里巴巴集团控股有限公司 | 信息查询方法及装置 |
| CN106339313B (zh) * | 2016-08-12 | 2018-10-12 | 南京航空航天大学 | 一种Java API程序异常与文档的描述不一致自动检测方法 |
| CN106339313A (zh) * | 2016-08-12 | 2017-01-18 | 南京航空航天大学 | 一种Java API程序异常与文档的描述不一致自动检测方法 |
| CN106681708A (zh) * | 2016-11-16 | 2017-05-17 | 中国科学院软件研究所 | 一种基于数据挖掘的源代码注释自动生成方法 |
| CN107885499A (zh) * | 2017-10-19 | 2018-04-06 | 平安壹钱包电子商务有限公司 | 一种接口文档生成方法及终端设备 |
| CN109799990B (zh) * | 2017-11-16 | 2022-02-11 | 中标软件有限公司 | 源代码注释自动生成方法及系统 |
| CN109799990A (zh) * | 2017-11-16 | 2019-05-24 | 中标软件有限公司 | 源代码注释自动生成方法及系统 |
| CN109901934B (zh) * | 2017-12-11 | 2022-01-28 | 北京京东尚科信息技术有限公司 | 生成接口帮助文档的方法和装置 |
| CN109901934A (zh) * | 2017-12-11 | 2019-06-18 | 北京京东尚科信息技术有限公司 | 生成接口帮助文档的方法和装置 |
| CN108021353B (zh) * | 2017-12-11 | 2020-09-29 | 中盈优创资讯科技有限公司 | 软件产品的说明文档的生成装置、方法、设备及存储介质 |
| CN108021353A (zh) * | 2017-12-11 | 2018-05-11 | 中盈优创资讯科技有限公司 | 软件产品的说明文档的生成装置、方法、设备及存储介质 |
| WO2019169814A1 (zh) * | 2018-03-09 | 2019-09-12 | 平安科技（深圳）有限公司 | 自动生成中文注释的方法、装置、设备及存储介质 |
| CN108920181A (zh) * | 2018-06-29 | 2018-11-30 | 北京拜克洛克科技有限公司 | 文件处理方法、装置及电子设备 |
| CN110955416A (zh) * | 2019-10-12 | 2020-04-03 | 平安普惠企业管理有限公司 | 接口文档生成方法、装置、设备和计算机存储介质 |
| CN112836477A (zh) * | 2021-01-15 | 2021-05-25 | 亿企赢网络科技有限公司 | 代码注释文档的生成方法、装置、电子设备及存储介质 |
| CN112836477B (zh) * | 2021-01-15 | 2024-02-09 | 亿企赢网络科技有限公司 | 代码注释文档的生成方法、装置、电子设备及存储介质 |
| CN113495753A (zh) * | 2021-07-06 | 2021-10-12 | 北京百度网讯科技有限公司 | 项目的标签获取方法、装置、电子设备及存储介质 |
| CN115599388A (zh) * | 2022-10-17 | 2023-01-13 | 中航信移动科技有限公司（Cn） | 一种api接口文档生成方法、存储介质及电子设备 |
| CN115599388B (zh) * | 2022-10-17 | 2023-07-21 | 中航信移动科技有限公司 | 一种api接口文档生成方法、存储介质及电子设备 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN102129365A (zh) | 一种生成代码说明文档的方法及装置 | |
| KR102317535B1 (ko) | 소프트웨어 개발 키트로 데이터 추적을 구현하는 방법 및 시스템 | |
| CN101739390B (zh) | 基于技术设计文档的数据转换 | |
| Devlin et al. | Language at work: Analyzing communication breakdown in the workplace to inform systems design | |
| CN101681377B (zh) | 用于搜索的用户定义的相关性排序 | |
| CN106997393A (zh) | 数据查询方法、装置、服务器及存储介质 | |
| CN104077147A (zh) | 一种基于代码克隆自动检测和及时提醒的软件复用方法 | |
| CN104360865A (zh) | 一种序列化方法、反序列化方法及相关设备 | |
| Walls et al. | XDoclet in Action (In Action series) | |
| JP2010267264A (ja) | コンポーネント・ベース・アプリケーションに対して実行可能なコードを構築する方法、その方法を実行するプログラムを含むコンピュータ可読の記憶媒体、およびコンパイラ | |
| CN111143446A (zh) | 数据对象的数据结构转换处理方法、装置及电子设备 | |
| CN103425632A (zh) | 一种序列化的方法、装置及处理器 | |
| CN110083749A (zh) | 用于软件快速开发的检索、复用、环境搭建的系统及方法 | |
| CN109766085A (zh) | 一种处理枚举类型代码的方法及装置 | |
| CN103605528A (zh) | 一种业务开发方法及装置 | |
| KR101877828B1 (ko) | 인공지능 기반의 사용자 인터페이스 통합 플랫폼 시스템 | |
| CN103077192A (zh) | 一种数据处理方法及其系统 | |
| CN103955429A (zh) | 确定回归测试范围的方法及装置 | |
| CN113434542B (zh) | 数据关系识别方法、装置、电子设备及存储介质 | |
| CN108694194A (zh) | 一种构造数据对象的方法和装置 | |
| US20130055296A1 (en) | Dynamically binding data in an application | |
| CN105677427A (zh) | 一种模块升级的方法及装置 | |
| CN109740130B (zh) | 用于生成文件的方法和装置 | |
| CN102402420B (zh) | 解析可观察集合 | |
| CN104536897A (zh) | 基于关键字的自动测试方法及系统 |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| C06 | Publication | ||
| PB01 | Publication | ||
| C10 | Entry into substantive examination | ||
| SE01 | Entry into force of request for substantive examination | ||
| REG | Reference to a national code |
Ref country code: HK Ref legal event code: DE Ref document number: 1154668 Country of ref document: HK |
|
| C12 | Rejection of a patent application after its publication | ||
| RJ01 | Rejection of invention patent application after publication |
Application publication date: 20110720 |
|
| REG | Reference to a national code |
Ref country code: HK Ref legal event code: WD Ref document number: 1154668 Country of ref document: HK |