Java源代码注释及关键字分析程序

项目链接：Java源代码注释及关键字分析程序

本文同步发布于我的小站

题目描述

编写一个 Java 应用程序，对单个 Java 源程序文件及某个目录中的所有 Java 源程序文件（包括子目录）进

行分析，分析内容包括：

• Java 源程序文件个数，对目录分析进行分析时需要。

• Java 源程序中的字符个数，对目录分析时是其中所有源程序文件的字符个数总和。

• Java 源程序文件中的注释的个数，即源程序文件中共有多少个注释，包括：单行注释和多行注释。对目录

  分析时是其中所有源程序文件的总和。

• Java 源程序文件中的注释的字符个数，即源程序文件中所有注释的字符数之和。对目录分析时是其中所有

  源程序文件的总和。

• Java 源程序文件中关键字使用情况，即源程序文件各个关键字使用了多少次。对目录分析时是其中所有源

  程序文件的总和。

程序介绍

主要是对文件读入，再一行一行分析，利用栈实现关键词分析，使用javaFX实现图形界面。

程序静态结构

首先程序的入口是APP这个类，通过APP调用Application.main方法运行项目（不然无法导出jar包）。

Application这个类同时控制了resource文件夹中的Menu.fxml文件，通过start方法读取Menu.fxml运行主页面，通过button控件调用类FileMenu类运行文件分析界面，与及调用Analyze类运行输入文件路径界面。

Analyze类控制了Analyze.fxml文件，运行输入文件路径界面，通过buttun控件调用类AnalyzeFile中静态方法checkFile（源文件）或checkAllFile（目录）分析文件或目录。

AnalyzeFile类是主要的文件分析类，通过静态方法checkFile（源文件）或checkAllFile（目录）调用类内部的静态私有方法分析文件。

FileMenu类运行查看分析文件界面，可以通过控件调用Application类回退Menu主页面，也可以选择文件调用Overlook类后进入文件查看界面。

Overlook类运行文件查看界面，可以通过控件调用FileMenu类回退查看分析文件界面。

Data类主要是用来存储数据，主要是静态变量，方便各个类调用。

KeyWord类是存储关键词类，通过实现compareTo接口实现排序。

outputFile和readFile类是从文件中读取数据的类，使用静态方法方便调用。

类图：

文件目录：

程序主要功能

（本部分介绍程序主要的功能，如加载文件、保存文件、统计分析等的算法，使用流程图或自然语言描述，不要直接贴代码。是实验报告的主要部分之一）

保存文件和加载文件

Data类中保存了我们分析文件的信息，OutputFile类和readFile类有一个静态方法可以直接调用实现加载文件、保存文件。

保存文件先mkdir文件夹，再创建对应文件输出数据，循环方式一行一行地输出。

加载文件首先是从Data类中获取我们需要的File的路径和名称，再从文件中循环读取。

统计分析

统计分析主要由AnalyzeFile类完成，由Data、keyWord类辅助。

AnalyzeFile类中checkAllFile()函数是分析目录时调用的函数，checkFile(String)函数是分析单个源文件调用的函数。

首先是分析Java 源程序文件个数，如果分析的是文件则不需要分析源程序文件个数，如果是目录则由AnalyzeFile类中checkAllFile()函数实现，如果目录中还有目录则递归调用checkAllFile(File)函数，checkAllFile函数进行了重载实现。getFileExernsion函数可以通过文件名获得文件的后缀名从而判断是否是Java 源程序文件。

分析Java 源程序中的字符个数由AnalyzeFile类中getCharacterNumber()函数实现,在checkFile或者checkAllFile时会调用getLines函数从文件中读取字符串存储进Data中的链表Lines中，再调用getCharacterNumber函数对Lines链表遍历读取字符数并相加。

分析Java 源程序文件中的注释，由AnalyzeFile类中checkComment函数实现，而此函数由对应分析类型的checkFile函数调用。主要方法是对Lines链表遍历，检测到有 // 注释则//后内容均为注释字符，如果检测到/**/ 或 /***/此类注释则要等到检测到对应结束符*/才结束注释，中间内容为注释字符，每检测到一个注释，注释个数即Data.commentNumber加一。

分析Java 源程序文件中关键字使用情况，由AnalyzeFile类中checkWord()函数实现。Data中存储着每一个关键字的数组KEYWORDS，由KEYWORDS构造出一个关键词的链表wordLinkedList和一个HashMap wordHashMap，HashMap的键是关键字，值是关键字的出现次数，初始化值为0。在checkWord函数中遍历链表Lines，使用一个字符串String read模拟栈实现读入字符，循环遍历每一行字符串，如果遇到注释或者“”语句则不将此处的字符入栈，再根据一个单词的分隔规则判断是否将字符入栈，如果检测到一个单词结束则将该单词与Hashmap中键对比确认是否为关键字，如果是关键字则值加一。

实现输出单词排序

KeyWord类实现Comparable接口，并重写compareTo，使其能够根据值number和name从大到小排序。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wzSnq6Zm-1642645809091)(file:///C:\Users\Edward\AppData\Local\Temp\ksohtml\wps1B4C.tmp.jpg)]

程序测试

主界面

选择1进入文件分析界面，选择2进入查看已分析文件界面，选择0退出程序。

文件分析界面

在方框内输入路径，点击确认按钮进行分析。

如果路径不存在，则提示：输入的目录或文件名不存在。

如果输入的文件名的扩展名不是“.java”时提示不是 Java 源程序文件。

如果输入的是一个 Java 源程序文件名，对该源程序文件进行分析。

如果输入的是一个目录名，对该目录中所有的源程序文件进行分析。

查看已分析文件

可以自己选择需要查看的文件，并点击选择进入查看分析界面。

查看分析

点击查看可以看到具体的分析结果，点击返回返回到上一界面。