背景有時(shí)，我們需要?jiǎng)h除Java源代碼中的注釋。目前有不少方法，比如：
本文針對(duì)Java語(yǔ)言，介紹一種利用第三方庫(kù)的方式，可以方便快速地移除代碼中的注釋。 原理這個(gè)第三方庫(kù)叫做JavaParser。它可以分析Java源碼，并生成語(yǔ)法分析樹（AST），其中注釋也屬于AST中的節(jié)點(diǎn)。 因此核心思路即為：
import java.util.ArrayList;import java.util.stream.Collectors;/**
* @author xiaoxi666
* @date 2021-02-15 17:13
* 我是 Javadoc 注釋 */public class Input {/** * 我是 Javadoc 注釋
*
* @param param1
* @param param2 */public static void someMethod(String param1, // 我是單行注釋 String param2// 我是單行注釋 String param3,/* 我是塊注釋 String param4,
String param5,
String param6 *//* 我是塊注釋 String param4 */)
{// 我是單行注釋int a = 1;/* 我是塊注釋，注意我和Javadoc注釋的區(qū)別，我只有一個(gè)星號(hào) */int b = 2;/* * 我是塊注釋 */int c = 3;
String s1 = "// 我是字符串中的內(nèi)容，不是注釋";
String s2 = "/* 我是字符串中的內(nèi)容，不是注釋 */";
String s3 = "/** 我是字符串中的內(nèi)容，不是注釋 */";
}
}我這里使用maven管理項(xiàng)目，首先引入JavaParser依賴： <dependencies><dependency> <groupId>com.github.javaparser</groupId> <artifactId>javaparser-symbol-solver-core</artifactId> <version>3.18.0</version></dependency></dependencies> =<CompilationUnit> result =<CompilationUnit> optionalCompilationUnit = (! ""= <Comment> comments =<Comment> unwantedComments = = comment LineComment || comment 在上面的代碼中，我們首先創(chuàng)建JavaParser，再解析源碼，然后移除單行注釋和塊注釋，最后再用LexicalPreservingPrinter將處理后的源碼打印出來(lái)，這個(gè)打印器可以保留源代碼所有詞法，比如空格、換行之類的元素。上述代碼已有注釋，因此不再詳述。 封裝為IDEA插件 考慮到我們平時(shí)可能會(huì)大量使用該功能，因此將其封裝為了IDEA插件，名為remove.comments。下面簡(jiǎn)要介紹該插件的工作原理及使用方式。PS：本文不會(huì)詳細(xì)介紹如何編寫IDEA插件。 IDEA插件的原理基本都是事件驅(qū)動(dòng)，如下圖所示，我們創(chuàng)建了一個(gè)事件監(jiān)聽器，當(dāng)檢測(cè)到編輯器中點(diǎn)擊右鍵后，即可彈出菜單，我們的插件在菜單中的第一個(gè)位置。 接下來(lái)，實(shí)現(xiàn)事件處理器：
/**
* 移除代碼中的注釋
*
* @param editor
* @return true if remove comments successfully */private boolean removeComments(Editor editor) {
String src = editor.getDocument().getText();if (Strings.isNullOrEmpty(src)) {return false;
}
String dst = CommentsRemover.doAction(checkEndLineAndModifyIfNeed(src));if (Strings.isNullOrEmpty(dst)) {return false;
}
editor.getDocument().setText(dst);return true;
}/**
* 由于我們保留了源碼格式，移除注釋之后會(huì)引入不必要的空格，因此需要再格式化一下
*
* @param editor
* @param project */private void reformat(Editor editor, Project project) {
PsiDocumentManager.getInstance(project).commitAllDocuments();
PsiFile file = PsiDocumentManager.getInstance(project).getPsiFile(editor.getDocument());if (file == null) {return;
}
LastRunReformatCodeOptionsProvider provider = new LastRunReformatCodeOptionsProvider(PropertiesComponent.getInstance());
ReformatCodeRunOptions currentRunOptions = provider.getLastRunOptions(file);
TextRangeType processingScope = TextRangeType.WHOLE_FILE;
currentRunOptions.setProcessingScope(processingScope);
(new FileInEditorProcessor(file, editor, currentRunOptions)).processCode();
} 插件打包好之后，用戶就可以從本地磁盤安裝了：  在彈出的目錄樹中，選中remove.comments.zip安裝包，確定即可。 重啟IDEA后，可以看到插件已安裝成功： 此時(shí)我們就可以使用該插件，一鍵刪除代碼中的注釋了。演示一下效果：
不嚴(yán)格性能測(cè)試（響應(yīng)時(shí)間包括插件處理時(shí)間和IDEA界面更新時(shí)間）：
總之，日常使用毫無(wú)壓力。 總結(jié)本文首先介紹了若干刪除注釋的手段；繼而介紹了一種利用第三方庫(kù)JavaParser刪除Java注釋的思路，并加以分析和實(shí)踐；最終將其封裝為IDEA插件，方便其他用戶使用。 另外，由于本人對(duì)JavaParser的認(rèn)知不是特別深入，難免存在未考慮到的場(chǎng)景。若大家在使用過(guò)程中發(fā)現(xiàn)bug，歡迎到github提issue甚至pr。 資源 源碼均已放在github：https://github.com/xiaoxi666/remove.comments。 插件也已經(jīng)上傳至github，可點(diǎn)擊下載?；蛘哧P(guān)注公眾號(hào)「xiaoxi666」，后臺(tái)回復(fù)「刪除注釋」，即可收到插件下載地址。
針對(duì)文中提出的第一種狀態(tài)機(jī)思路，之前也寫文章介紹過(guò)。有興趣的讀者可嘗試動(dòng)手實(shí)現(xiàn)一下。鏈接：https://www.cnblogs.com/xiaoxi666/p/7931763.html 最后 再給自己的公眾號(hào)打個(gè)廣告，歡迎大家關(guān)注我的公眾號(hào)：xiaoxi666，一起來(lái)玩一起學(xué)！ |
|
|
