CN105677317A - 一种生成代码文档的方法和装置 - Google Patents

Abstract

本发明公开了一种生成代码文档的方法和装置。其中所述方法包括：定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件；根据所述代码文件的代码内容生成相应的文档；将生成的文档保存到所述指定项目的文档目录下。该技术方案大大减少了开发人员的负担，不需要花费大量时间在文档的撰写方面，可以更投入项目开发，同时也为后加入的开发人员等需要阅读文档的人员提供了可读性较好的文档，极大地方便了各类用户。

Description

一种生成代码文档的方法和装置

技术领域

本发明涉及计算机技术领域，具体涉及一种生成代码文档的方法和装置。

背景技术

在程序开发的过程中，程序员的流动性通常是很大的。一个公司可能同时有若干个开发项目，除了公司可能有新员工入职后加入已有的项目组的情况外，还可能存在多个项目组之间有人员流动的情况。这样，就需要考虑项目交接时能否使该项目组的新员工快速了解项目需求和进展等情况。当然，程序员可以直接阅读项目已开发的代码，但这要耗费大量时间。一种较好的方式是阅读项目代码的文档，但开发人员往往没有大量的时间来撰写文档。

发明内容

鉴于上述问题，提出了本发明以便提供一种克服上述问题或者至少部分地解决上述问题的生成代码文档的方法和装置。

依据本发明的一个方面，提供了一种生成代码文档的方法，包括：

定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件；

根据所述代码文件的代码内容生成相应的文档；

将生成的文档保存到所述指定项目的文档目录下。

可选地，所述根据所述代码文件的代码内容生成相应的文档包括：

提取代码文件中的注释信息作为文档的内容。

可选地，所述根据所述代码文件内容生成相应的文档包括：

识别代码文件中的程序语言调用关系，生成相应的函数调用关系图表作为文档的内容。

可选地，所述扫描开发机上的指定项目的代码文件目录下的代码文件包括：

查看扫描配置文件；

扫描配置文件中指定的项目的代码文件目录下的代码文件。

可选地，该方法进一步包括：

进行扫描之前，判断待扫描的代码文件的最后修改日期是否早于上一次进行扫描的日期；

如果是，则不进行扫描；

如果否，则进行扫描。

依据本发明的另一方面，提供了一种生成代码文档的装置，包括：

代码扫描单元，适于定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件；

文档生成单元，适于根据所述代码文件的代码内容生成相应的文档；

文档保存单元，适于将生成的文档保存到所述指定项目的文档目录下。

可选地，所述文档生成单元，适于提取代码文件中的注释信息作为文档的内容。

可选地，所述文档生成单元，适于识别代码文件中的程序语言调用关系，生成相应的函数调用关系图表作为文档的内容。

可选地，所述代码扫描单元，进一步适于查看扫描配置文件，扫描配置文件中指定的项目的代码文件目录下的代码文件。

可选地，所述代码扫描单元，进一步适于在进行扫描之前，判断待扫描的代码文件的最后修改日期是否早于上一次进行扫描的日期；如果是，则不进行扫描；如果否，则进行扫描。

由上述可知，本发明的技术方案，通过定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件，并根据所述代码文件的代码内容生成相应的文档，最后将生成的文档保存到所述指定项目的文档目录下，就完成了代码文档的自动生成，该技术方案大大减少了开发人员的负担，不需要花费大量时间在文档的撰写方面，可以更投入项目开发，同时也为后加入的开发人员等需要阅读文档的人员提供了可读性较好的文档，极大地方便了各类用户。

上述说明仅是本发明技术方案的概述，为了能够更清楚了解本发明的技术手段，而可依照说明书的内容予以实施，并且为了让本发明的上述和其它目的、特征和优点能够更明显易懂，以下特举本发明的具体实施方式。

附图说明

通过阅读下文优选实施方式的详细描述，各种其他的优点和益处对于本领域普通技术人员将变得清楚明了。附图仅用于示出优选实施方式的目的，而并不认为是对本发明的限制。而且在整个附图中，用相同的参考符号表示相同的部件。在附图中：

图1示出了根据本发明一个实施例的一种生成代码文档的方法的流程示意图；

图2示出了根据本发明一个实施例的一种生成代码文档的装置的结构示意图。

具体实施方式

下面将参照附图更详细地描述本公开的示例性实施例。虽然附图中显示了本公开的示例性实施例，然而应当理解，可以以各种形式实现本公开而不应被这里阐述的实施例所限制。相反，提供这些实施例是为了能够更透彻地理解本公开，并且能够将本公开的范围完整的传达给本领域的技术人员。

图1示出了根据本发明一个实施例的一种生成代码文档的方法的流程示意图，如图1所示，该方法包括：

步骤S110，定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件。

步骤S120，根据所述代码文件的代码内容生成相应的文档。

步骤S130，将生成的文档保存到所述指定项目的文档目录下。

可见，图1所示的方法，通过定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件，并根据所述代码文件的代码内容生成相应的文档，最后将生成的文档保存到所述指定项目的文档目录下，就完成了代码文档的自动生成，该技术方案大大减少了开发人员的负担，不需要花费大量时间在文档的撰写方面，可以更投入项目开发，同时也为后加入的开发人员等需要阅读文档的人员提供了可读性较好的文档，极大地方便了各类用户。

在本发明的一个实施例中，图1所示的方法中，所述根据所述代码文件的代码内容生成相应的文档包括：提取代码文件中的注释信息作为文档的内容。

开发人员(主要是程序员)在撰写代码的过程中往往会为某些代码撰写以“//”开头的注释信息，例如描述使用某个函数的目的。这些注释信息往往对阅读代码起到很大的帮助，但比较零碎。在本实施例中将代码文件中的注释信息提取出来作为文档的内容，就可以形成一份完整的对代码的解释说明文件，也就实现了文档的主要功能。例如，根据注释整理得到一份包含UML图的文档。UML(UnifiedModelingLanguage，统一建模语言)是一个支持模型化和软件系统开发的图形化语言，为软件开发的所有阶段提供模型化和可视化支持，包括由需求分析到规格，到构造和配置。UML规范用来描述建模的概念有类(对象的)、对象、关联、职责、行为、接口、用例、包、顺序、协作，以及状态。

在本发明的一个实施例中，上述方法中，所述根据所述代码文件内容生成相应的文档包括：识别代码文件中的程序语言调用关系，生成相应的函数调用关系图表作为文档的内容。

在知道代码使用的编程语言后就可以很容易识别代码文件中的程序语言调用关系，并基于此生成相应的函数调用关系图表，例如，函数A调用函数B，函数B又调用了函数C，以代码的形式可以很清晰的描述这种调用关系，但将这种调用关系提取出来生成调用关系图表可以更快地使文档阅读者了解代码的逻辑关系，提高了极大的阅读体验。

在本发明的一个实施例中，图1所示的方法中，所述扫描开发机上的指定项目的代码文件目录下的代码文件包括：查看扫描配置文件；扫描配置文件中指定的项目的代码文件目录下的代码文件。

考虑到在开发过程中需要多次修改代码，可以将还需进行多次修改的代码放在特定的文件夹下，将可以进行代码文档生成的代码放在另一些特定的文件夹下。在扫描配置文件中可以配置扫描的时间、扫描的文件夹，生成文档也有了更多的规范性。

在本发明的一个实施例中，图1所示的方法进一步包括：进行扫描之前，判断待扫描的代码文件的最后修改日期是否早于上一次进行扫描的日期；如果是，则不进行扫描；如果否，则进行扫描。

如果代码文件没有修改则不会产生新的文档。上一实施例中提及，开发过程中需要多次修改代码，也可以在还需要多次修改的代码文件中加入一个标识(例如特定的文件名格式)，如果代码文件包含该标识则不对该代码文件进行扫描。

图2示出了根据本发明一个实施例的一种生成代码文档的装置的结构示意图，如图2所示，生成代码文档的装置200包括：

代码扫描单元210，适于定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件。

文档生成单元220，适于根据所述代码文件的代码内容生成相应的文档。

文档保存单元230，适于将生成的文档保存到所述指定项目的文档目录下。

可见，图2所示的装置，通过各单元的相互配合，定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件，并根据所述代码文件的代码内容生成相应的文档，最后将生成的文档保存到所述指定项目的文档目录下，就完成了代码文档的自动生成，该技术方案大大减少了开发人员的负担，不需要花费大量时间在文档的撰写方面，可以更投入项目开发，同时也为后加入的开发人员等需要阅读文档的人员提供了可读性较好的文档，极大地方便了各类用户。

在本发明的一个实施例中，图2所示的装置中，所述文档生成单元220，适于提取代码文件中的注释信息作为文档的内容。

开发人员(主要是程序员)在撰写代码的过程中往往会为某些代码撰写以“//”开头的注释信息，例如描述使用某个函数的目的。这些注释信息往往对阅读代码起到很大的帮助，但比较零碎。在本实施例中将代码文件中的注释信息提取出来作为文档的内容，就可以形成一份完整的对代码的解释说明文件，也就实现了文档的主要功能。例如，根据注释整理得到一份包含UML图的文档。

在本发明的一个实施例中，上述装置中，所述文档生成单元220，适于识别代码文件中的程序语言调用关系，生成相应的函数调用关系图表作为文档的内容。

在知道代码使用的编程语言后就可以很容易识别代码文件中的程序语言调用关系，并基于此生成相应的函数调用关系图表，例如，函数A调用函数B，函数B又调用了函数C，以代码的形式可以很清晰的描述这种调用关系，但将这种调用关系提取出来生成调用关系图表可以更快地使文档阅读者了解代码的逻辑关系，提高了极大的阅读体验。

在本发明的一个实施例中，图2所示的装置中，所述代码扫描单元210，进一步适于查看扫描配置文件，扫描配置文件中指定的项目的代码文件目录下的代码文件。

考虑到在开发过程中需要多次修改代码，可以将还需进行多次修改的代码放在特定的文件夹下，将可以进行代码文档生成的代码放在另一些特定的文件夹下。在扫描配置文件中可以配置扫描的时间、扫描的文件夹，生成文档也有了更多的规范性。

在本发明的一个实施例中，图2所示的装置中，所述代码扫描单元210，进一步适于在进行扫描之前，判断待扫描的代码文件的最后修改日期是否早于上一次进行扫描的日期；如果是，则不进行扫描；如果否，则进行扫描。

如果代码文件没有修改则不会主动生成新的文档。上一实施例中提及，开发过程中需要多次修改代码，也可以在还需要多次修改的代码文件中加入一个标识(例如特定的文件名格式)，如果代码文件包含该标识则不对该代码文件进行扫描。

综上所述，本发明的技术方案，通过定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件，并根据所述代码文件的代码内容生成相应的文档，最后将生成的文档保存到所述指定项目的文档目录下，就完成了代码文档的自动生成，该技术方案大大减少了开发人员的负担，不需要花费大量时间在文档的撰写方面，可以更投入项目开发，同时也为后加入的开发人员等需要阅读文档的人员提供了可读性较好的文档，极大地方便了各类用户。

需要说明的是：

在此提供的算法和显示不与任何特定计算机、虚拟装置或者其它设备固有相关。各种通用装置也可以与基于在此的示教一起使用。根据上面的描述，构造这类装置所要求的结构是显而易见的。此外，本发明也不针对任何特定编程语言。应当明白，可以利用各种编程语言实现在此描述的本发明的内容，并且上面对特定语言所做的描述是为了披露本发明的最佳实施方式。

在此处所提供的说明书中，说明了大量具体细节。然而，能够理解，本发明的实施例可以在没有这些具体细节的情况下实践。在一些实例中，并未详细示出公知的方法、结构和技术，以便不模糊对本说明书的理解。

类似地，应当理解，为了精简本公开并帮助理解各个发明方面中的一个或多个，在上面对本发明的示例性实施例的描述中，本发明的各个特征有时被一起分组到单个实施例、图、或者对其的描述中。然而，并不应将该公开的方法解释成反映如下意图：即所要求保护的本发明要求比在每个权利要求中所明确记载的特征更多的特征。更确切地说，如下面的权利要求书所反映的那样，发明方面在于少于前面公开的单个实施例的所有特征。因此，遵循具体实施方式的权利要求书由此明确地并入该具体实施方式，其中每个权利要求本身都作为本发明的单独实施例。

本领域那些技术人员可以理解，可以对实施例中的设备中的模块进行自适应性地改变并且把它们设置在与该实施例不同的一个或多个设备中。可以把实施例中的模块或单元或组件组合成一个模块或单元或组件，以及此外可以把它们分成多个子模块或子单元或子组件。除了这样的特征和/或过程或者单元中的至少一些是相互排斥之外，可以采用任何组合对本说明书(包括伴随的权利要求、摘要和附图)中公开的所有特征以及如此公开的任何方法或者设备的所有过程或单元进行组合。除非另外明确陈述，本说明书(包括伴随的权利要求、摘要和附图)中公开的每个特征可以由提供相同、等同或相似目的的替代特征来代替。

此外，本领域的技术人员能够理解，尽管在此所述的一些实施例包括其它实施例中所包括的某些特征而不是其它特征，但是不同实施例的特征的组合意味着处于本发明的范围之内并且形成不同的实施例。例如，在下面的权利要求书中，所要求保护的实施例的任意之一都可以以任意的组合方式来使用。

本发明的各个部件实施例可以以硬件实现，或者以在一个或者多个处理器上运行的软件模块实现，或者以它们的组合实现。本领域的技术人员应当理解，可以在实践中使用微处理器或者数字信号处理器(DSP)来实现根据本发明实施例的生成代码文档的装置中的一些或者全部部件的一些或者全部功能。本发明还可以实现为用于执行这里所描述的方法的一部分或者全部的设备或者装置程序(例如，计算机程序和计算机程序产品)。这样的实现本发明的程序可以存储在计算机可读介质上，或者可以具有一个或者多个信号的形式。这样的信号可以从因特网网站上下载得到，或者在载体信号上提供，或者以任何其他形式提供。

应该注意的是上述实施例对本发明进行说明而不是对本发明进行限制，并且本领域技术人员在不脱离所附权利要求的范围的情况下可设计出替换实施例。在权利要求中，不应将位于括号之间的任何参考符号构造成对权利要求的限制。单词“包含”不排除存在未列在权利要求中的元件或步骤。位于元件之前的单词“一”或“一个”不排除存在多个这样的元件。本发明可以借助于包括有若干不同元件的硬件以及借助于适当编程的计算机来实现。在列举了若干装置的单元权利要求中，这些装置中的若干个可以是通过同一个硬件项来具体体现。单词第一、第二、以及第三等的使用不表示任何顺序。可将这些单词解释为名称。

Claims (10)

1.一种生成代码文档的方法，其中，该方法包括：

定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件；

根据所述代码文件的代码内容生成相应的文档；

将生成的文档保存到所述指定项目的文档目录下。

2.如权利要求1所述的方法，其中，所述根据所述代码文件的代码内容生成相应的文档包括：

提取代码文件中的注释信息作为文档的内容。

3.如权利要求1或2所述的方法，其中，所述根据所述代码文件内容生成相应的文档包括：

识别代码文件中的程序语言调用关系，生成相应的函数调用关系图表作为文档的内容。

4.如权利要求1所述的方法，其中，所述扫描开发机上的指定项目的代码文件目录下的代码文件包括：

查看扫描配置文件；

扫描配置文件中指定的项目的代码文件目录下的代码文件。

5.如权利要求1所述的方法，其中，该方法进一步包括：

进行扫描之前，判断待扫描的代码文件的最后修改日期是否早于上一次进行扫描的日期；

如果是，则不进行扫描；

如果否，则进行扫描。

6.一种生成代码文档的装置，其中，该装置包括：

代码扫描单元，适于定期或不定期扫描开发机上的指定项目的代码文件目录下的代码文件；

文档生成单元，适于根据所述代码文件的代码内容生成相应的文档；

文档保存单元，适于将生成的文档保存到所述指定项目的文档目录下。

7.如权利要求6所述的装置，其中，

所述文档生成单元，适于提取代码文件中的注释信息作为文档的内容。

8.如权利要求6或7所述的装置，其中，

所述文档生成单元，适于识别代码文件中的程序语言调用关系，生成相应的函数调用关系图表作为文档的内容。

9.如权利要求6所述的装置，其中，

所述代码扫描单元，进一步适于查看扫描配置文件，扫描配置文件中指定的项目的代码文件目录下的代码文件。

10.如权利要求6所述的装置，其中，

所述代码扫描单元，进一步适于在进行扫描之前，判断待扫描的代码文件的最后修改日期是否早于上一次进行扫描的日期；如果是，则不进行扫描；如果否，则进行扫描。